Enrich all connectors#483
Merged
Pranesh-Raghu merged 4 commits intoMar 13, 2026
Merged
Conversation
Pranesh-Raghu
requested review from
amitash1912,
ravibits and
saif-at-scalekit
as code owners
Contributor
WalkthroughUpdated ~40 agent-connector MDX setup guides: replaced imported/static image assets with inline Markdown images, standardized alt text and wording, and expanded step-by-step instructions (notably redirect-URI copy prompts and "use your own credentials" flows). No functional code or exported API changes. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Suggested labels
Suggested reviewers
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 22
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (3)
src/components/templates/agent-connectors/_setup-slack.mdx (1)
1-1: 🧹 Nitpick | 🔵 TrivialUnused
Asideimport.The
Asidecomponent is imported but not used in this file. Consider removing it to keep imports clean.🧹 Proposed fix
-import { Steps, Aside } from '@astrojs/starlight/components' +import { Steps } from '@astrojs/starlight/components'🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/components/templates/agent-connectors/_setup-slack.mdx` at line 1, The import list includes an unused symbol Aside from '@astrojs/starlight/components' which should be removed to clean up imports; open the file containing the import statement (the line with "import { Steps, Aside } from '@astrojs/starlight/components'") and remove Aside from the destructured import so it reads only "Steps", ensuring no other references to Aside exist in the file before committing the change.src/components/templates/agent-connectors/_setup-asana.mdx (1)
1-1:⚠️ Potential issue | 🟡 MinorRemove unused
AsideimportThe
Asidecomponent is imported but never used in this file. Remove it from line 1 to keep imports clean.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/components/templates/agent-connectors/_setup-asana.mdx` at line 1, The import list includes an unused symbol Aside; remove Aside from the named import on the import statement (i.e., change the import of { Steps, Aside, Badge } to { Steps, Badge } so only used components remain imported).src/components/templates/agent-connectors/_setup-monday.mdx (1)
1-1: 🧹 Nitpick | 🔵 TrivialRemove unused
Asideimport.
Asideis imported but never used in this file.🧹 Proposed fix
-import { Steps, Aside } from '@astrojs/starlight/components' +import { Steps } from '@astrojs/starlight/components'🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/components/templates/agent-connectors/_setup-monday.mdx` at line 1, The import statement includes an unused symbol Aside; edit the import from '@astrojs/starlight/components' to remove Aside and only import Steps (i.e., update the import where Steps and Aside are declared so Aside is no longer imported), ensuring there are no other references to Aside in this file before committing the change.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@src/components/templates/agent-connectors/_setup-bigquery.mdx`:
- Line 28: Add descriptive alt text to the BigQuery API screenshot markdown in
src/components/templates/agent-connectors/_setup-bigquery.mdx by replacing the
empty alt brackets for enable-bigquery-api.png with a concise description (e.g.,
"Google Cloud Console: Enable the BigQuery API for your project") so screen
readers convey the image purpose; update the image tag referencing
enable-bigquery-api.png accordingly and ensure it follows the same alt-text
guidance used for other non-redirect screenshots in the agent-connectors
templates.
- Around line 30-32: Update the "Get client credentials" section (heading "Get
client credentials") to explicitly instruct the reader to copy the generated
Client ID and Client Secret from the Google OAuth client details before
navigating back to Scalekit so Step 4 is immediately actionable; word it as a
direct, sequential command (e.g., "Copy the Client ID and Client Secret now and
keep them secure, then return to Scalekit to paste them into Step 4") so readers
know exactly what to do next.
- Around line 18-22: The screenshots referenced in this MDX use
connector-specific paths
("@/assets/docs/agent-connectors/gmail/oauth-web-app.png" and
"@/assets/docs/agent-connectors/gmail/add-redirect-uri.png"); move these files
to a connector-agnostic shared assets folder (e.g.,
"@/assets/docs/agent-connectors/shared/") and update the image references in
_setup-bigquery.mdx (and the other occurrence that reuses the same gmail paths)
to point to the new shared paths so later Gmail-specific cleanup won't break the
template.
In `@src/components/templates/agent-connectors/_setup-dropbox.mdx`:
- Line 13: The sentence "If you are testing, go directly to the next section."
is ambiguous; replace it with a direct instruction that explicitly tells readers
what to skip and what to complete before production. Update the sentence in the
"By default..." paragraph to something like: "If you are testing, skip the
production credential setup steps below and proceed to the Testing steps; before
going to production, complete the production credential setup described below."
Locate and edit the exact text containing "By default, a connection using
Scalekit's credentials will be created. If you are testing, go directly to the
next section." and make the skip path explicit as shown.
In `@src/components/templates/agent-connectors/_setup-gong.mdx`:
- Around line 28-30: The two bullet lines under the Gong Developer Portal step
are redundant ("listed under **Client ID**"/"listed under **Client Secret**");
simplify them to directly state the credentials to copy by replacing those
bullets with concise lines like "- **Client ID** — your app's client identifier"
and "- **Client Secret** — your app's client secret" so the section that
currently shows "Client ID" and "Client Secret" is clearer and non-repetitive.
- Around line 37-39: The list items "Client ID", "Client Secret", and
"Permissions" are not bolded and should match the rest of the document; update
the three list entries so the UI field names are wrapped in bold (e.g., **Client
ID**, **Client Secret**, **Permissions**) to maintain consistent formatting with
other sections that bold field names.
In `@src/components/templates/agent-connectors/_setup-google-ads.mdx`:
- Around line 16-22: Update the two image references that point to
Gmail-specific assets ('@/assets/docs/agent-connectors/gmail/oauth-web-app.png'
and '@/assets/docs/agent-connectors/gmail/add-redirect-uri.png') so the Google
Ads template no longer depends on Gmail assets: either move/duplicate those
files into a shared Google OAuth assets folder (e.g.,
'@/assets/docs/agent-connectors/google_oauth/') or into a connector-specific
'google_ads' folder, and then change the image paths in _setup-google-ads.mdx to
the new locations; ensure both occurrences (the oauth-web-app and
add-redirect-uri image references) are updated to the chosen shared path.
In `@src/components/templates/agent-connectors/_setup-google-drive.mdx`:
- Around line 16-22: The MDX file _setup-google-drive.mdx references
Gmail-specific images under agent-connectors/gmail/, creating an unintended
coupling; copy or move the shared Google OAuth screenshots to a neutral location
(e.g., assets/docs/agent-connectors/google_drive/ or a shared oauth/ folder) and
update the image links in _setup-google-drive.mdx (the two instances of
"@/assets/docs/agent-connectors/gmail/...") to point to the new asset paths;
ensure the copied images are added to the repo and the markdown image references
match the new filenames so builds and image rendering remain correct.
In `@src/components/templates/agent-connectors/_setup-google-meets.mdx`:
- Line 24: The Step heading inside the <Steps> component uses "### Enable the
Google Meet API" but must follow the repo's numbered Steps syntax; change that
heading to "2. ## Enable the Google Meet API" (keeping the same text) and ensure
all content belonging to this step is indented with exactly 3 spaces as required
by the docs parser; update the heading token in the _setup-google-meets.mdx file
so the touched step follows the `1. ## Title` numbered format (here using 2.)
and maintain consistent indentation for the step body.
- Line 30: The sentence "Google provides your Client ID and Client Secret after
you create the OAuth client ID in step 1" is missing where to copy those values
from; update the doc to tell users to open the Google Cloud Console > APIs &
Services > Credentials, select the newly created OAuth 2.0 Client ID and copy
the "Client ID" and "Client secret" fields from that credentials detail view,
and add a brief verification step instructing them to confirm the values by
pasting them into the connector form or environment variables to ensure they
match.
- Around line 18-22: The screenshots are stored under a Gmail-specific folder
and should live in a neutral shared asset location; move the files
'@/assets/docs/agent-connectors/gmail/oauth-web-app.png' and
'@/assets/docs/agent-connectors/gmail/add-redirect-uri.png' into a neutral
folder (e.g., '@/assets/docs/agent-connectors/shared/' or
'@/assets/docs/agent-connectors/google-console/'), update the image references
in src/components/templates/agent-connectors/_setup-google-meets.mdx to point to
the new paths, and also update any other occurrences (the other reference noted
around lines 40) to use the same shared paths so the Google Meet guide isn’t
coupled to the Gmail asset folder.
In `@src/components/templates/agent-connectors/_setup-google-sheets.mdx`:
- Line 24: Update the step heading inside the <Steps> component from the current
"2. ### Enable the Google Sheets API" to the repository's numbered step heading
format "2. ## Enable the Google Sheets API" and ensure the step's content uses
the required 3-space indentation; in short, replace the triple-hash heading with
a double-hash numbered heading following the "1. ## Title" pattern used by the
Steps component and adjust indentation for all content under that step.
- Around line 18-22: The Google Sheets setup template references images under
"@/assets/docs/agent-connectors/gmail/...", coupling it to the Gmail connector;
move the shared Google OAuth screenshots into a provider-level shared folder or
duplicate them into a google_sheets-specific folder and then update the image
references in this template (replace "@/assets/docs/agent-connectors/gmail/..."
with the new "@/assets/docs/agent-connectors/google_sheets/..." or shared path)
for the two occurrences shown and also for the other occurrence noted ("40-40").
In `@src/components/templates/agent-connectors/_setup-googleslides.mdx`:
- Line 12: Replace the plain Markdown outbound links (e.g., the "Scalekit
dashboard" link and other occurrences referencing "Google Slides" and the
redirect URI) with the repo's external-link pattern or explicit anchor tags that
include target="_blank" and rel="noopener"; update the MDX in
_setup-googleslides.mdx for the links mentioned on the shown lines (and the
other occurrences at lines 16 and 26) so each external URL is rendered with
target="_blank" and rel="noopener" attributes instead of a plain Markdown link.
- Line 30: Update Step 3 to be an explicit action: replace the sentence "Google
provides your Client ID and Client Secret after you create the OAuth client ID
in step 1." with a direct instruction telling the reader to copy or download and
securely save the Client ID and Client Secret (e.g., "Copy or download the
Client ID and Client Secret now and store them securely — you will need them in
Step 4"). Use an imperative heading for Step 3 (action verb) and ensure the
wording references "from above" in Step 4 will clearly point to these saved
credentials.
- Around line 24-26: Replace the "### Enable the Google Slides API" heading with
the Steps-style header "1. ## Enable the Google Slides API" and change the
following line(s) that describe the action so they use exactly 3 spaces of
indentation (instead of 4) before the content; target the block containing the
text "Google Slides API" and the library-enable instruction so the step adheres
to the repo's required Steps syntax.
In `@src/components/templates/agent-connectors/_setup-intercom.mdx`:
- Line 20: The step headings in this template use the wrong heading format;
inside the <Steps> component replace numbered "N. ### Title" headings with the
repository standard "1. ## Title" pattern (e.g., change "2. ### Get client
credentials" to "1. ## Get client credentials") and apply the same conversion to
all other step headings in this file; also ensure every line of content within
each <Steps> step is indented by exactly 3 spaces so it matches the Steps
component convention.
In `@src/components/templates/agent-connectors/_setup-jira.mdx`:
- Line 1: The file imports Aside from '@astrojs/starlight/components' but never
uses it, so remove the unused import to fix the lint/unused symbol issue: delete
Aside from the import statement (i.e., change "import { Steps, Aside } from
'@astrojs/starlight/components'" to only import Steps) and ensure no other
references to Aside exist in the file (check for any mentions of Aside in the
_setup-jira.mdx content).
In `@src/components/templates/agent-connectors/_setup-onedrive.mdx`:
- Line 12: Update the phrasing in the OneDrive setup sentence by replacing the
string "Azure Active Directory" with "Microsoft Entra ID" so the line reads:
Sign into [portal.azure.com](https://portal.azure.com) and go to **Microsoft
Entra ID** → **App registrations** → **New registration**; locate and update any
identical occurrences in the same template (e.g., the sentence that begins "Sign
into [portal.azure.com]...") to match current Microsoft branding.
In `@src/components/templates/agent-connectors/_setup-onenote.mdx`:
- Line 12: Replace the legacy branding phrase "Azure Active Directory" with
"Microsoft Entra ID" in the OneNote connector setup text (the line containing
"Sign into portal.azure.com and go to **Azure Active Directory** → **App
registrations** → **New registration**), ensuring the exact phrase "Microsoft
Entra ID" appears in place of "Azure Active Directory" and that any other
occurrences in this _setup-onenote.mdx file follow the same replacement for
consistency with the Outlook connector.
In `@src/components/templates/agent-connectors/_setup-snowflake.mdx`:
- Around line 42-43: The two list items "Client ID (from the SQL output)" and
"Client Secret (from the SQL output)" are not bolded like the earlier
occurrences; update those exact lines to use bold formatting (i.e., **Client ID
(from the SQL output)** and **Client Secret (from the SQL output)**) so
credential field names are consistently formatted across the document.
In `@src/components/templates/agent-connectors/_setup-zendesk.mdx`:
- Line 20: Replace the Markdown link "Scalekit dashboard" in _setup-zendesk.mdx
with an HTML <a> element that includes the required external-link attributes
(target="_blank" and rel="noopener") and preserves the href and link text; apply
the same change pattern to other agent-connector setup templates that use
Markdown links so external links consistently include target and rel attributes.
---
Outside diff comments:
In `@src/components/templates/agent-connectors/_setup-asana.mdx`:
- Line 1: The import list includes an unused symbol Aside; remove Aside from the
named import on the import statement (i.e., change the import of { Steps, Aside,
Badge } to { Steps, Badge } so only used components remain imported).
In `@src/components/templates/agent-connectors/_setup-monday.mdx`:
- Line 1: The import statement includes an unused symbol Aside; edit the import
from '@astrojs/starlight/components' to remove Aside and only import Steps
(i.e., update the import where Steps and Aside are declared so Aside is no
longer imported), ensuring there are no other references to Aside in this file
before committing the change.
In `@src/components/templates/agent-connectors/_setup-slack.mdx`:
- Line 1: The import list includes an unused symbol Aside from
'@astrojs/starlight/components' which should be removed to clean up imports;
open the file containing the import statement (the line with "import { Steps,
Aside } from '@astrojs/starlight/components'") and remove Aside from the
destructured import so it reads only "Steps", ensuring no other references to
Aside exist in the file before committing the change.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: d9fc5f89-5f4d-4623-b898-1735eac0450f
⛔ Files ignored due to path filters (41)
src/assets/docs/agent-connectors/apollo/add-credentials.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/apollo/add-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/asana/add-credentials.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/asana/add-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/dropbox/add-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/github/add-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/gong/add-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/hubspot/add-credentials.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/hubspot/use-own-credentials-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/intercom/add-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/jira/add-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/linear/add-credentials.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/linear/add-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/microsoft_teams/add-credentials.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/microsoft_teams/add-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/microsoft_teams/use-own-credentials-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/microsoftexcel/add-credentials.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/microsoftexcel/add-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/microsoftexcel/use-own-credentials-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/microsoftword/add-credentials.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/microsoftword/add-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/microsoftword/use-own-credentials-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/monday/add-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/notion/add-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/onedrive/add-credentials.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/onedrive/add-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/onedrive/use-own-credentials-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/onenote/add-credentials.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/onenote/add-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/onenote/use-own-credentials-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/outlook/add-credentials.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/outlook/add-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/outlook/use-own-credentials-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/salesforce/add-credentials.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/salesforce/add-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/salesforce/use-own-credentials-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/sharepoint/add-credentials.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/sharepoint/add-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/sharepoint/use-own-credentials-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/slack/add-credentials.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/slack/use-own-credentials-redirect-uri.pngis excluded by!**/*.png
📒 Files selected for processing (37)
src/components/templates/agent-connectors/_setup-airtable.mdxsrc/components/templates/agent-connectors/_setup-apollo.mdxsrc/components/templates/agent-connectors/_setup-asana.mdxsrc/components/templates/agent-connectors/_setup-bigquery.mdxsrc/components/templates/agent-connectors/_setup-clickup.mdxsrc/components/templates/agent-connectors/_setup-confluence.mdxsrc/components/templates/agent-connectors/_setup-dropbox.mdxsrc/components/templates/agent-connectors/_setup-github.mdxsrc/components/templates/agent-connectors/_setup-gmail.mdxsrc/components/templates/agent-connectors/_setup-gong.mdxsrc/components/templates/agent-connectors/_setup-google-ads.mdxsrc/components/templates/agent-connectors/_setup-google-docs.mdxsrc/components/templates/agent-connectors/_setup-google-drive.mdxsrc/components/templates/agent-connectors/_setup-google-forms.mdxsrc/components/templates/agent-connectors/_setup-google-meets.mdxsrc/components/templates/agent-connectors/_setup-google-sheets.mdxsrc/components/templates/agent-connectors/_setup-googlecalendar.mdxsrc/components/templates/agent-connectors/_setup-googleslides.mdxsrc/components/templates/agent-connectors/_setup-hubspot.mdxsrc/components/templates/agent-connectors/_setup-intercom.mdxsrc/components/templates/agent-connectors/_setup-jira.mdxsrc/components/templates/agent-connectors/_setup-linear.mdxsrc/components/templates/agent-connectors/_setup-microsoft-excel.mdxsrc/components/templates/agent-connectors/_setup-microsoft-teams.mdxsrc/components/templates/agent-connectors/_setup-microsoft-word.mdxsrc/components/templates/agent-connectors/_setup-monday.mdxsrc/components/templates/agent-connectors/_setup-notion.mdxsrc/components/templates/agent-connectors/_setup-onedrive.mdxsrc/components/templates/agent-connectors/_setup-onenote.mdxsrc/components/templates/agent-connectors/_setup-outlook.mdxsrc/components/templates/agent-connectors/_setup-salesforce.mdxsrc/components/templates/agent-connectors/_setup-servicenow.mdxsrc/components/templates/agent-connectors/_setup-sharepoint.mdxsrc/components/templates/agent-connectors/_setup-slack.mdxsrc/components/templates/agent-connectors/_setup-snowflake.mdxsrc/components/templates/agent-connectors/_setup-zendesk.mdxsrc/components/templates/agent-connectors/_setup-zoom.mdx
…ith scope table and plan notes
✅ Deploy Preview for scalekit-starlight ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@src/components/templates/agent-connectors/_setup-apollo.mdx`:
- Around line 17-28: Remove the duplicated OAuth scopes markdown table that
appears under "Step 1" (the step where users copy the redirect URI) and keep the
single scopes table under "Step 2" where users actually select scopes in
Apollo's app registration; locate the repeated table block (the pipe-delimited
Scope | Required for table) in the _setup-apollo.mdx content and delete the
first occurrence so only the table referenced in Step 2 remains.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: 4100eda0-52ea-47ab-8b62-d27faf77e54e
📒 Files selected for processing (1)
src/components/templates/agent-connectors/_setup-apollo.mdx
📜 Review details
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: Redirect rules - scalekit-starlight
- GitHub Check: Header rules - scalekit-starlight
- GitHub Check: Pages changed - scalekit-starlight
🧰 Additional context used
📓 Path-based instructions (3)
**/*.mdx
📄 CodeRabbit inference engine (.cursorrules)
**/*.mdx: Use clear, descriptive titles that explain the purpose of the document
Include comprehensive descriptions in frontmatter metadata
Organize content with logical heading hierarchy (H2, H3, H4)
Use tableOfContents property in frontmatter when content has multiple sections
Set appropriate sidebar labels for navigation in frontmatter
Use direct instruction writing style with phrases like 'This guide shows you how to...' and 'Create an authorization URL to...'
Use second person perspective ('your application', 'you receive', 'you must') in documentation
Keep sentences concise, aiming for under 25 words per sentence
Explain the 'why' in documentation with phrases like 'This prevents CSRF attacks by...' or 'Use this to validate that...'
Use action verbs in section headings: 'Store session tokens securely', 'Validate the state parameter', 'Exchange authorization code for tokens'
Use present tense for descriptions: 'Scalekit handles the complex authentication flow', 'The SDK provides methods to refresh tokens'
Use future tense for results: 'This will redirect users to...', 'You'll receive a JWT containing...', 'Scalekit returns an authorization code'
Use transition phrases between sections: 'After the user authenticates...', 'Once the state is validated...', 'Let's take a look at how to...'
Write 1-3 opening paragraphs that explain what users will accomplish, provide context about when/why, preview key concepts, and use direct instructional language
Begin introduction sections with a clear statement of what the guide covers and explain the problem being solved
Use collapsible sections in introduction for sequence diagrams, video demonstrations, data models, and JSON examples with appropriate icons
Use numbered format within Steps component:1. ## Titlewith all step content indented with exactly 3 spaces
Use action-oriented headings in step-by-step guides within Steps components
Include code examples in all 4 languages (Node.js, Python, Go, Java) within Steps co...
Files:
src/components/templates/agent-connectors/_setup-apollo.mdx
⚙️ CodeRabbit configuration file
**/*.mdx: You are reviewing Scalekit developer documentation written in MDX
(Astro + Starlight framework). Apply ALL of the following checks:Frontmatter
titleMUST be ≤ 60 characters and clearly state what the page does.descriptionMUST be ≤ 160 characters, action-oriented, unique per page.sidebar.labelMUST be present and ≤ 30 characters.sidebar.orderMUST be set on every page that lives inside a section
with siblings, to enforce the journey order in sidebar.config.ts.- Flag any missing
prev/nextlinks on pages that are clearly
part of a sequential flow (e.g., quickstart → implement-login →
complete-login → manage-session → logout).Voice & Style (CLAUDE.md standards)
- Voice: confident, direct, collaborative, instructional.
- Person: second person only ("you", "your application"). Reject "we",
"our", "the developer", "the user".- Tense: present tense for descriptions; imperative mood for instructions.
- Flag weasel words: "simply", "just", "easy", "straightforward",
"obviously", "of course", "note that".- Flag passive voice constructions where active voice is clearer.
- Headings must be sentence case, not Title Case (except proper nouns).
- No heading should end with a colon or period.
Content structure
- How-to guides MUST contain numbered
<Steps>(Starlight component).- Concept pages MUST NOT contain numbered steps — concepts explain, not instruct.
- API reference pages MUST list parameters in a table with Name / Type /
Required / Description columns.- Every page MUST end with a clear "what's next" signal — either a
next:frontmatter link, a<LinkCard>, or an explicit paragraph
pointing the reader forward in the sidebar journey.Code examples
- ALL code examples that show SDK usage MUST include all four language
tabs: Node.js, Python, Go, Java — using<Tabs syncKey="tech-stack">.- SDK variable names are STRICTLY:
scalekit(Node.js),
scalekit_client(Python),scalekitClient(Go), ...
Files:
src/components/templates/agent-connectors/_setup-apollo.mdx
**/*.{yml,yaml,md,mdx}
📄 CodeRabbit inference engine (.cursor/rules/browsecentral-labels.mdc)
**/*.{yml,yaml,md,mdx}: BrowseCentral labels should be maximum 3-5 words - keep concise but add context when needed
BrowseCentral labels should be action-oriented - start with verbs when possible
BrowseCentral labels should be specific and clear - add context when simple labels are ambiguous
BrowseCentral labels should be outcome-focused - describe what users accomplish and the context
BrowseCentral labels should use 'Action + Object' pattern (e.g., 'Invite users', 'Restrict sign-up', 'Set up SCIM')
BrowseCentral labels should use feature names (e.g., 'Enterprise SSO', 'Passwordless quickstart')
BrowseCentral labels should describe task completion (e.g., 'Run migrations', 'Migrate auth', 'Merge identities')
BrowseCentral labels should include specific context when needed (e.g., 'Configure Scalekit MCP server', 'Validate incoming API requests')
BrowseCentral labels should use integration context when applicable (e.g., 'Build MCP auth with your existing auth system')
BrowseCentral labels should avoid instructional prefixes: 'How to', 'Guide to', 'Implement', 'Configure', 'Learn', 'Understand'
BrowseCentral labels should avoid verbose phrases: 'Step-by-step guide', 'Complete tutorial', 'Detailed documentation'
BrowseCentral labels should avoid weak verbs: 'Enable', 'Allow', 'Provide', 'Support'
Files:
src/components/templates/agent-connectors/_setup-apollo.mdx
**/*.{md,mdx}
📄 CodeRabbit inference engine (.cursor/rules/deno-docs-style.mdc)
**/*.{md,mdx}: Use sentence case for all titles and headings in MD/MDX documentation
Keep page titles short and descriptive (3–7 words when possible) in MD/MDX documentation
Use outcome-focused headings that describe results, not categories (e.g., 'Run a script' not 'Scripts')
Avoid gerunds in headings when an imperative works - prefer 'Configure proxies' over 'Configuring proxies'
Keep sidebar labels concise (1–3 words), use sentence case, and focus on outcomes or objects
Use sentence case in sidebar labels without punctuation
Set frontmatter title in sentence case with a clear outcome; description in one sentence (≤160 chars); sidebar.label as shorter form of title; enable tableOfContents on longer pages
Start documentation pages with a one-paragraph overview explaining what the page covers and when to use it
Present the primary use case (80% path) first in documentation, with edge cases later
Use numbered steps for task-focused sections in documentation, with each step beginning with a verb
Break up long documentation sections with subheadings every 3–6 paragraphs
Use asides for important notes, tips, cautions, and references in documentation
Provide runnable, minimal code examples that work as-is in documentation
Prefer CLI-first examples and show file layout when helpful in documentation
Label code blocks with titles for context (e.g., 'Terminal', 'main.ts') in documentation
Keep code block annotations brief and purposeful - annotate only what matters
Use consistent variable and file names across a documentation page
Use descriptive link text in documentation (e.g., 'See permission flags' not 'click here')
Prefer relative links for internal documentation pages and include anchors for section references
Reference APIs consistently using backticks for code, file names, CLI flags, and endpoints
Use backticks for code, file names, CLI flags, and endpoints in documentation
Use lists for options and features in documentation; tables only when comparisons are cleare...
Files:
src/components/templates/agent-connectors/_setup-apollo.mdx
🧠 Learnings (13)
📓 Common learnings
Learnt from: Pranesh-Raghu
Repo: scalekit-inc/developer-docs PR: 475
File: src/components/templates/agent-connectors/_setup-asana.mdx:15-15
Timestamp: 2026-03-10T10:37:49.873Z
Learning: In `src/components/templates/agent-connectors/`, all connector setup MDX files (e.g., _setup-asana.mdx, _setup-clickup.mdx, _setup-confluence.mdx, _setup-googlecalendar.mdx, _setup-intercom.mdx, _setup-monday.mdx, _setup-notion.mdx, _setup-zoom.mdx) intentionally use a single shared redirect URI screenshot (`use-own-credentials-redirect-uri.png` located under `@/assets/docs/agent-connectors/<connector-name>/`) for all redirect URI-related steps, even when steps show different UIs (e.g., Scalekit dashboard vs. the third-party console). Do not flag reuse of this image across multiple steps within the same connector file as an issue.
Learnt from: Pranesh-Raghu
Repo: scalekit-inc/developer-docs PR: 475
File: src/components/templates/agent-connectors/_setup-confluence.mdx:16-16
Timestamp: 2026-03-10T10:38:35.371Z
Learning: In `src/components/templates/agent-connectors/_setup-*.mdx` files, empty alt text `![]()` for redirect URI screenshots (e.g., `use-own-credentials-redirect-uri.png`) is a deliberate and consistent pattern across all connector setup template files. Do not flag missing alt text on these images in future reviews of files under `src/components/templates/agent-connectors/`.
Learnt from: Pranesh-Raghu
Repo: scalekit-inc/developer-docs PR: 475
File: src/components/templates/agent-connectors/_setup-clickup.mdx:17-17
Timestamp: 2026-03-10T10:38:36.402Z
Learning: In `src/components/templates/agent-connectors/_setup-*.mdx` template files, empty alt text `![]()` is the established pattern for redirect URI screenshot images. Do not flag missing alt text on `![]()` markdown image syntax in these agent connector setup template files.
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 448
File: src/content/docs/reference/agent-connectors/googlesheets.mdx:95-141
Timestamp: 2026-02-26T07:22:55.583Z
Learning: For MDX files under src/content/docs/reference/agent-connectors/, the parameter tables (showing tool properties) are auto-generated from JSON API responses by scripts/sync-agent-connectors.js. Any table format corrections must be made in the generation script, not by manually editing the generated MDX files. The script should be updated to output the required "Name | Type | Required | Description" four-column table format per coding guidelines.
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 448
File: src/content/docs/reference/agent-connectors/googlesheets.mdx:82-82
Timestamp: 2026-02-26T07:21:12.772Z
Learning: For agent connector documentation files under src/content/docs/reference/agent-connectors/, prefer CDN URLs (https://cdn.scalekit.cloud/sk-connect/assets/provider-icons/) for connector logo images rather than storing them locally in src/assets/docs/. This differs from the general guideline to use local assets.
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 448
File: src/content/docs/reference/agent-connectors/microsoftword.mdx:3-3
Timestamp: 2026-02-26T07:23:27.672Z
Learning: For MDX files under src/content/docs/reference/agent-connectors/, do not enforce the 160-character description limit. These files are auto-generated from API payloads via scripts/sync-agent-connectors.js and may have longer descriptions from the source data.
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 448
File: src/content/docs/reference/agent-connectors/googlesheets.mdx:89-131
Timestamp: 2026-02-26T07:21:37.207Z
Learning: In src/content/docs/reference/agent-connectors/** MDX files, tool headings (e.g., `googlesheets_create_spreadsheet`, `googlesheets_get_values`) intentionally use H2 (##) instead of H3 to ensure they appear in the table of contents for easier navigation. This is a deliberate UX choice for agent connector reference pages and should not be flagged as a hierarchy issue.
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 455
File: src/content/docs/reference/agent-connectors/asana.mdx:94-173
Timestamp: 2026-03-03T13:35:56.400Z
Learning: For Agent Connectors documentation (src/content/docs/reference/agent-connectors/**/*.mdx), currently only Python SDK support is available for Agent Actions/Agent Connectors. Do not require or enforce the multi-language SDK code examples (Node.js, Python, Go, Java) guideline for these connector docs until SDK support is ready in other languages. The Node.js, Go, and Java examples can be added once the respective SDKs support Agent Actions features.
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-03-03T10:47:47.162Z
Learning: Applies to src/content/docs/**/*.{md,mdx} : Product-based documentation (MCP Auth, Agent Auth, Full Stack Auth, Modular SCIM, Modular SSO) MUST follow a journey-focused approach. Each product represents a developer's journey toward implementing authentication in their projects.
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursorrules:0-0
Timestamp: 2026-01-13T12:46:55.260Z
Learning: Applies to **/*.mdx : Reference images in MDX files with proper paths using `@/assets/docs/` prefix and include alt text
📚 Learning: 2026-03-10T10:37:47.033Z
Learnt from: Pranesh-Raghu
Repo: scalekit-inc/developer-docs PR: 475
File: src/components/templates/agent-connectors/_setup-asana.mdx:15-15
Timestamp: 2026-03-10T10:37:47.033Z
Learning: In src/components/templates/agent-connectors/**/*.mdx, it is acceptable to reuse a single shared redirect URI screenshot (use-own-credentials-redirect-uri.png) across multiple steps within the same connector file, even if different UIs are shown. Do not flag this reuse as an issue; ensure this behavior is intentional and documented for reviewers.
Applied to files:
src/components/templates/agent-connectors/_setup-apollo.mdx
📚 Learning: 2026-03-10T10:38:27.783Z
Learnt from: Pranesh-Raghu
Repo: scalekit-inc/developer-docs PR: 475
File: src/components/templates/agent-connectors/_setup-confluence.mdx:16-16
Timestamp: 2026-03-10T10:38:27.783Z
Learning: In all MDX templates under src/components/templates/agent-connectors, the pattern uses empty alt text (e.g., ![]()) for redirect URI screenshots like use-own-credentials-redirect-uri.png. This is intentional; reviews should not flag missing alt text for these images in this directory.
Applied to files:
src/components/templates/agent-connectors/_setup-apollo.mdx
📚 Learning: 2026-03-10T10:38:30.012Z
Learnt from: Pranesh-Raghu
Repo: scalekit-inc/developer-docs PR: 475
File: src/components/templates/agent-connectors/_setup-clickup.mdx:17-17
Timestamp: 2026-03-10T10:38:30.012Z
Learning: In the repository's agent-connectors setup template files (src/components/templates/agent-connectors/_setup-*.mdx), the pattern for redirect URI screenshot images is to use empty alt text (![]()). Do not flag missing alt text for these specific Markdown image syntaxes in the agent connector setup template files. This guidance applies only to files matching this setup-*.mdx naming pattern; other templates should continue to enforce standard alt text practices.
Applied to files:
src/components/templates/agent-connectors/_setup-apollo.mdx
📚 Learning: 2026-01-13T12:46:55.260Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursorrules:0-0
Timestamp: 2026-01-13T12:46:55.260Z
Learning: Applies to **/*.mdx : Include configuration comments in code examples: '// Get the signing secret from Scalekit dashboard > Interceptors tab'
Applied to files:
src/components/templates/agent-connectors/_setup-apollo.mdx
📚 Learning: 2026-02-26T07:22:55.583Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 448
File: src/content/docs/reference/agent-connectors/googlesheets.mdx:95-141
Timestamp: 2026-02-26T07:22:55.583Z
Learning: For MDX files under src/content/docs/reference/agent-connectors/, the parameter tables (showing tool properties) are auto-generated from JSON API responses by scripts/sync-agent-connectors.js. Any table format corrections must be made in the generation script, not by manually editing the generated MDX files. The script should be updated to output the required "Name | Type | Required | Description" four-column table format per coding guidelines.
Applied to files:
src/components/templates/agent-connectors/_setup-apollo.mdx
📚 Learning: 2026-02-10T05:32:59.967Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 424
File: public/api/scalekit.scalar.json:3451-3457
Timestamp: 2026-02-10T05:32:59.967Z
Learning: In scalekit-inc/developer-docs, the file public/api/scalekit.scalar.json is a generated OpenAPI artifact; reviewers should avoid direct edits. For inconsistencies (e.g., the /api/v1/permissions "type" query param description vs. enum), handle short-term via release/PR notes and track long-term fixes in the generator or source templates rather than modifying the generated JSON.
Applied to files:
src/components/templates/agent-connectors/_setup-apollo.mdx
📚 Learning: 2026-01-13T12:46:55.260Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursorrules:0-0
Timestamp: 2026-01-13T12:46:55.260Z
Learning: Applies to **/*.mdx : Use present tense for descriptions: 'Scalekit handles the complex authentication flow', 'The SDK provides methods to refresh tokens'
Applied to files:
src/components/templates/agent-connectors/_setup-apollo.mdx
📚 Learning: 2026-02-26T07:21:12.772Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 448
File: src/content/docs/reference/agent-connectors/googlesheets.mdx:82-82
Timestamp: 2026-02-26T07:21:12.772Z
Learning: For agent connector documentation files under src/content/docs/reference/agent-connectors/, prefer CDN URLs (https://cdn.scalekit.cloud/sk-connect/assets/provider-icons/) for connector logo images rather than storing them locally in src/assets/docs/. This differs from the general guideline to use local assets.
Applied to files:
src/components/templates/agent-connectors/_setup-apollo.mdx
📚 Learning: 2026-02-26T07:21:37.207Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 448
File: src/content/docs/reference/agent-connectors/googlesheets.mdx:89-131
Timestamp: 2026-02-26T07:21:37.207Z
Learning: In src/content/docs/reference/agent-connectors/** MDX files, tool headings (e.g., `googlesheets_create_spreadsheet`, `googlesheets_get_values`) intentionally use H2 (##) instead of H3 to ensure they appear in the table of contents for easier navigation. This is a deliberate UX choice for agent connector reference pages and should not be flagged as a hierarchy issue.
Applied to files:
src/components/templates/agent-connectors/_setup-apollo.mdx
📚 Learning: 2026-02-26T07:23:27.672Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 448
File: src/content/docs/reference/agent-connectors/microsoftword.mdx:3-3
Timestamp: 2026-02-26T07:23:27.672Z
Learning: For MDX files under src/content/docs/reference/agent-connectors/, do not enforce the 160-character description limit. These files are auto-generated from API payloads via scripts/sync-agent-connectors.js and may have longer descriptions from the source data.
Applied to files:
src/components/templates/agent-connectors/_setup-apollo.mdx
📚 Learning: 2026-02-25T03:34:41.147Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 444
File: src/content/docs/agent-auth/start-agent-auth-coding-agents.mdx:31-31
Timestamp: 2026-02-25T03:34:41.147Z
Learning: In MDX files, import { Code } from 'astrojs/starlight/components' only if the MDX content actually uses the <Code> component. If the file uses only fenced code blocks (```), the import is not required. Apply this guideline to all MDX files (e.g., src/content/docs/**/*.mdx) to avoid unnecessary imports and reduce bundle size.
Applied to files:
src/components/templates/agent-connectors/_setup-apollo.mdx
📚 Learning: 2026-02-25T18:41:00.639Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 446
File: src/content/docs/authenticate/m2m/api-auth-quickstart.mdx:78-78
Timestamp: 2026-02-25T18:41:00.639Z
Learning: Preserve full URLs inside code comments in MDX code blocks (bash/python/js) when the URLs are part of copyable examples. Do not flag these in code examples. Use relative paths in prose and hyperlinks within MDX; only enforce relative paths for markdown prose links, not for URLs inside code comments.
Applied to files:
src/components/templates/agent-connectors/_setup-apollo.mdx
🔇 Additional comments (1)
src/components/templates/agent-connectors/_setup-apollo.mdx (1)
77-77: Good addition of descriptive alt text.The alt text clearly describes the image purpose, improving accessibility for screen readers.
✅ Deploy Preview for scalekit-starlight ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary by CodeRabbit