apollo connectors and tools#459
Conversation
Removed mention of ID tokens from claims field explanation.
MCP Topologies
…tom-auth-updates
Amended parameter name in docs to match SDK Parameter.
…k-updates Updating docs for federated auth with sdk support
…-inc#308) * Clarify documentation on custom claims in ID tokens by specifying that claims are only included in ID tokens, not access tokens. Adjusted wording for consistency and clarity in the interceptor scenarios guide. * Fix Steps component formatting in interceptor-scenarios.mdx - Remove ### headers from step titles to comply with Steps component requirements - Use **bold** formatting instead of headers for step titles - This fixes the build error where Steps component expected single ordered list * Use #### headers instead of bold formatting in Steps component - Testing shows that #### headers work with Starlight's Steps component - This provides better visual hierarchy while maintaining compatibility - ### headers cause build errors but #### headers are acceptable
* chore: start manage sessions remoately * fix: update session management examples to use correct SDK methods and improve clarity - Changed references from `scalekit.sessions` to `scalekit.session` in JavaScript, Python, Go, and Java examples. - Updated filtering parameters to use consistent casing for status and improved date handling in Python and Go examples. - Enhanced console output messages for revoked sessions to be more user-friendly. * feat: remove the mention of passwordless
* chore: start manage sessions remoately * fix: update session management examples to use correct SDK methods and improve clarity - Changed references from `scalekit.sessions` to `scalekit.session` in JavaScript, Python, Go, and Java examples. - Updated filtering parameters to use consistent casing for status and improved date handling in Python and Go examples. - Enhanced console output messages for revoked sessions to be more user-friendly. * feat: remove the mention of passwordless * fix: update SDK version in installation instructions - Changed Gradle and Maven dependency versions from `2.0.1` to `2.0.6` for the Scalekit SDK. * feat: add section for limiting user sign-ups in organization - Introduced a new section in the manage organization guide detailing how to limit the number of users in an organization. - Added an image to illustrate the process of updating organization settings for user limits. * feat: add user limits image and update references in user management settings - Added a new image for user limits in the user management settings documentation. - Updated the manage organization guide to clarify how to limit the number of users in an organization. * feat: enhance Scalekit API documentation with user management settings and environment details - Updated the Scalekit API specification to include new user management settings for organizations, allowing for maximum user limits. - Added detailed descriptions for development and production environments, including API URLs and subdomain variables. - Improved formatting and organization of the Swagger JSON file for better readability and consistency. - Clarified user limits in the manage organization guide, including a note on how limits affect user invitations. * fix: clarify user provisioning limits in manage organization guide - Updated the manage organization guide to specify that new user provisioning is blocked until organization limits are increased. - Removed redundant instructions and improved clarity by consolidating steps related to configuring user limits.
…kit-inc#314) - Reformatted the Swagger JSON file to enhance clarity by aligning array elements and object properties. - Updated tags for various API endpoints to use consistent array formatting. - Added a backup of the previous Swagger JSON file for reference. - Ensured all descriptions and examples are properly structured for better documentation quality.
…he MCP Inspector, as Dynamic Client Registration is the preferred approach (scalekit-inc#313) * Enhance FastMCP integration guide with additional context and clarification - Updated the introduction to clarify the purpose of the guide and the steps involved in securing a FastMCP server with Scalekit. - Added an Aside component to inform users about leaving the Inspector's Authentication fields empty to avoid errors with dynamic client registration. * Update src/content/docs/mcp/integrations/fastmcp.mdx
* Refactor webhook documentation structure and add new event types - Simplified sidebar configuration for webhooks by removing unnecessary nesting. - Updated the order of the 'Directory events' section in the sidebar. - Added new documentation files for 'Organization events', 'Permission events', 'Role events', 'Enterprise SSO events', and 'User events', detailing their respective webhook functionalities and JSON structures. - Ensured all new sections include comprehensive descriptions and structured content for clarity. * Add new webhook events and update documentation structure - Introduced new webhook events: `organization.directory_created` and `organization.directory_deleted` with placeholders for future documentation. - Updated section headings for consistency, changing 'Directory User Events' to 'Directory user events' and 'Directory Group Events' to 'Directory group events'. - Standardized the heading format for SSO and user authentication events for improved clarity. * Update webhook event documentation with new structures and examples - Revised JSON structures for organization, permission, role, and user events to reflect updated identifiers and attributes. - Enhanced descriptions for each event type, ensuring clarity on the purpose and data fields. - Removed deprecated fields and added new ones, such as `external_id` and `settings.features`, to improve accuracy and usability. - Standardized timestamps and organization details across all event types for consistency. * Remove outdated overviewTitle from organization events documentation * Enhance user event webhook documentation for clarity - Updated descriptions for `user.signup`, `user.login`, `user.logout`, `user.organization_membership_created`, `user.organization_membership_updated`, and `user.organization_membership_deleted` to provide clearer context on the events. - Ensured consistency in terminology and improved the understanding of each event's purpose and implications.
…scopes Add 'email' scope to Scalekit OIDC options
Removed membership details from user events in the webhook documentation.
…ent-change Remove membership details from user webhook events
…ng renaming the 'Organizations' endpoint to 'Connections'. (scalekit-inc#320) - Added new endpoints for resending user invitations and adding existing users to organizations, with detailed descriptions and parameters. - Improved examples for SDK usage across various programming languages. - Removed deprecated fields and ensured all definitions are up-to-date for better documentation quality.
…-sample Bring your own auth MCP Updates
…tion, and consent management Updated Quickstart guide to reflect the new UI in place
Pranesh-Raghu
requested review from
amitash1912,
ravibits and
saif-at-scalekit
as code owners
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
WalkthroughReplaced numerous connector-specific redirect-URI images with a unified Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (2 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}
✅ Deploy Preview for scalekit-starlight ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 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-clickup.mdx`:
- Line 17: The image tag in _setup-clickup.mdx currently has empty alt text;
update the markdown image at the line containing
to include a meaningful, descriptive alt string (e.g., "ClickUp OAuth redirect
URI setup screenshot" or similar) so the MDX uses proper alt text and follows
the "@/assets/docs/" reference guideline.
In `@src/components/templates/agent-connectors/_setup-linear.mdx`:
- Line 10: Replace the empty alt text for the image reference
""
with a concise, descriptive alt string that explains the image's content and
purpose (for example: "Illustration of the redirect URI field in Linear OAuth
settings showing where to paste your app's redirect URL"); update the markup in
the _setup-linear.mdx file so the image tag becomes something like
""
ensuring the alt text conveys what the image shows and its role for
screen-reader users.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: 9263223a-1bed-4be8-a149-08efe1457e34
⛔ Files ignored due to path filters (6)
src/assets/docs/_setup-asana/redirecturi-copy-asana.pngis excluded by!**/*.pngsrc/assets/docs/_setup-clickup/copy-clickup-redirecturi.pngis excluded by!**/*.pngsrc/assets/docs/_setup-linear/linear-redirect-copy.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/asana/use-own-credentials-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/clickup/use-own-credentials-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/linear/use-own-credentials-redirect-uri.pngis excluded by!**/*.png
📒 Files selected for processing (3)
src/components/templates/agent-connectors/_setup-asana.mdxsrc/components/templates/agent-connectors/_setup-clickup.mdxsrc/components/templates/agent-connectors/_setup-linear.mdx
📜 Review details
🧰 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-linear.mdxsrc/components/templates/agent-connectors/_setup-clickup.mdxsrc/components/templates/agent-connectors/_setup-asana.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-linear.mdxsrc/components/templates/agent-connectors/_setup-clickup.mdxsrc/components/templates/agent-connectors/_setup-asana.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-linear.mdxsrc/components/templates/agent-connectors/_setup-clickup.mdxsrc/components/templates/agent-connectors/_setup-asana.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-linear.mdxsrc/components/templates/agent-connectors/_setup-clickup.mdxsrc/components/templates/agent-connectors/_setup-asana.mdx
🧠 Learnings (9)
📓 Common learnings
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: 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/guides/integrations/**/*.{md,mdx} : Integration guides in `src/content/docs/guides/integrations/` MUST be kept synchronized with their index pages: `src/content/docs/guides/integrations/index.mdx`, `src/content/docs/guides/integrations/sso-integrations/index.mdx`, `src/content/docs/guides/integrations/social-connections/index.mdx`, and `src/content/docs/guides/integrations/scim-integrations/index.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-linear.mdxsrc/components/templates/agent-connectors/_setup-clickup.mdxsrc/components/templates/agent-connectors/_setup-asana.mdx
📚 Learning: 2026-02-26T07:18:51.377Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 448
File: scripts/sync-agent-connectors.js:0-0
Timestamp: 2026-02-26T07:18:51.377Z
Learning: In src/content/docs/reference/agent-connectors/**/*.mdx files, sidebar.label frontmatter is not required because the sidebar configuration references the agent-connectors directory for auto-generation. Navigation ordering and grouping are managed centrally in the sidebar configuration file.
Applied to files:
src/components/templates/agent-connectors/_setup-linear.mdxsrc/components/templates/agent-connectors/_setup-clickup.mdxsrc/components/templates/agent-connectors/_setup-asana.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-linear.mdxsrc/components/templates/agent-connectors/_setup-clickup.mdx
📚 Learning: 2026-02-26T07:20:46.903Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 448
File: src/content/docs/reference/agent-connectors/googlemeet.mdx:1-87
Timestamp: 2026-02-26T07:20:46.903Z
Learning: For auto-generated agent connector documentation pages in src/content/docs/reference/agent-connectors/, the "what's next" signal requirement (next: frontmatter link, <LinkCard>, or concluding paragraph) does not apply. These are reference pages generated by scripts/sync-agent-connectors.js and serve as lookup resources rather than sequential guides.
Applied to files:
src/components/templates/agent-connectors/_setup-linear.mdxsrc/components/templates/agent-connectors/_setup-clickup.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-linear.mdxsrc/components/templates/agent-connectors/_setup-clickup.mdxsrc/components/templates/agent-connectors/_setup-asana.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-linear.mdxsrc/components/templates/agent-connectors/_setup-clickup.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-linear.mdxsrc/components/templates/agent-connectors/_setup-clickup.mdxsrc/components/templates/agent-connectors/_setup-asana.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-linear.mdxsrc/components/templates/agent-connectors/_setup-clickup.mdxsrc/components/templates/agent-connectors/_setup-asana.mdx
🔇 Additional comments (1)
src/components/templates/agent-connectors/_setup-asana.mdx (1)
15-15: Good update to the Asana redirect image reference.Line 15 correctly switches to the new asset and includes descriptive alt text.
There was a problem hiding this comment.
Actionable comments posted: 4
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (5)
src/components/templates/agent-connectors/_setup-notion.mdx (1)
2-2:⚠️ Potential issue | 🟡 MinorAdd alt text and use the imported image variable.
The
useOwnCredentialsImgis imported but not used. The image on line 12 lacks alt text. Use the imported variable for consistency with line 33.Proposed fix
-  + <img src={useOwnCredentialsImg.src} alt="Copy the redirect URI from Scalekit dashboard" width="540" />Also applies to: 12-12
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/components/templates/agent-connectors/_setup-notion.mdx` at line 2, The imported image variable useOwnCredentialsImg is not being used and the image tag near the top of the document lacks alt text; replace the hardcoded image source there with the imported useOwnCredentialsImg and add meaningful alt text (e.g., "Use your own credentials redirect URI") so the import is actually referenced and the image is accessible/accessible to screen readers; verify the same pattern is used consistently like the image at line 33.src/components/templates/agent-connectors/_setup-intercom.mdx (1)
2-2:⚠️ Potential issue | 🟡 MinorAdd alt text and use the imported image variable.
The
useOwnCredentialsImgis imported but not used. The image on line 16 lacks alt text. Use the imported variable for consistency with line 37.Proposed fix
-  + <img src={useOwnCredentialsImg.src} alt="Copy the redirect URI from Scalekit dashboard" width="540" />Also applies to: 16-16
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/components/templates/agent-connectors/_setup-intercom.mdx` at line 2, Replace the hardcoded image src and missing alt attribute with the imported variable: use the imported symbol useOwnCredentialsImg as the src for the image element that currently lacks alt text, and add a concise, descriptive alt attribute (e.g., "Intercom redirect URI settings screenshot") to that img tag so it matches the usage style of the image at the other location using useOwnCredentialsImg.src/components/templates/agent-connectors/_setup-zoom.mdx (1)
2-2:⚠️ Potential issue | 🟡 MinorAdd alt text and use the imported image variable.
The
useOwnCredentialsImgis imported but not used. The image on line 13 also lacks alt text. Either use the imported variable with an<img>tag (consistent with lines 19 and 37), or add alt text to the markdown syntax.Option 1: Use the imported variable (preferred for consistency)
-  + <img src={useOwnCredentialsImg.src} alt="Copy the redirect URI from Scalekit dashboard" width="540" />Option 2: Add alt text to markdown syntax and remove unused import
Remove unused import on line 2:
-import useOwnCredentialsImg from '@/assets/docs/agent-connectors/zoom/use-own-credentials-redirect-uri.png'Add alt text on line 13:
-  + Also applies to: 13-13
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/components/templates/agent-connectors/_setup-zoom.mdx` at line 2, The imported image variable useOwnCredentialsImg is unused and the inline Markdown image lacks alt text; replace the Markdown image with the React-style image tag used elsewhere: render <img src={useOwnCredentialsImg} alt="Zoom: use your own credentials redirect URI" /> (consistent with other images in this file such as those around useOwnCredentialsImg usage) so the import is used and the image has descriptive alt text; alternatively, if you prefer Markdown, remove the unused import useOwnCredentialsImg and change the Markdown image to include alt text like  .src/components/templates/agent-connectors/_setup-monday.mdx (1)
2-2:⚠️ Potential issue | 🟡 MinorAdd alt text and use the imported image variable.
The
useOwnCredentialsImgis imported but not used. The image on line 16 lacks alt text. Use the imported variable for consistency with line 38, or add alt text and remove the unused import.Proposed fix: Use the imported variable
-  + <img src={useOwnCredentialsImg.src} alt="Copy the redirect URI from Scalekit dashboard" width="540" />Also applies to: 16-16
🤖 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 2, Replace the hardcoded image src on the page with the imported variable useOwnCredentialsImg and add descriptive alt text; specifically locate the img element referenced on the page (currently not using useOwnCredentialsImg) and change its src to useOwnCredentialsImg and include an appropriate alt attribute (e.g., alt="Use your own credentials - redirect URI example") so the import is used and accessibility is improved.src/components/templates/agent-connectors/_setup-confluence.mdx (1)
2-2:⚠️ Potential issue | 🟡 MinorAdd alt text and use the imported image variable.
The
useOwnCredentialsImgis imported but not used. The image on line 16 lacks alt text. Use the imported variable for consistency with lines 22 and 40.Proposed fix
-  + <img src={useOwnCredentialsImg.src} alt="Copy the redirect URI from Scalekit dashboard" width="540" />Also applies to: 16-16
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/components/templates/agent-connectors/_setup-confluence.mdx` at line 2, The imported image variable useOwnCredentialsImg is not being used and the inline image tag lacks alt text; update the image element that currently embeds the PNG (the one before the sections using images at lines similar to the other two instances) to use the imported variable useOwnCredentialsImg as its src and add a descriptive alt attribute (e.g., alt="Confluence: Use your own credentials redirect URI") to match the usage pattern found for the other images in this file.
🤖 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-airtable.mdx`:
- Line 14: The image markdown in _setup-airtable.mdx currently has an empty alt
text
([](`@/assets/docs/agent-connectors/airtable/use-own-credentials-redirect-uri.png`));
update that markdown to include a concise, descriptive alt string that describes
the image content (for example: "Airtable: Use own credentials redirect URI
screenshot" or similar) so the image tag 
contains accessible alt text.
In `@src/components/templates/agent-connectors/_setup-asana.mdx`:
- Line 10: The image markdown line missing alt text should be updated to include
a concise, descriptive alt attribute for accessibility; locate the line
containing
""
and replace the empty alt with a short description that conveys the image
purpose (for example: "Asana OAuth redirect URI setup screenshot showing client
ID, client secret, and redirect URI fields") so screen readers can understand
the content.
- Line 15: Replace the incorrect image reference in the Asana setup doc: find
the Markdown image at src/components/templates/agent-connectors/_setup-asana.mdx
that currently points to use-own-credentials-redirect-uri.png and update it to
reference the existing add-redirect-url.gif asset (use the alt text "Adding
Asana redirect URL" and the path
"@/assets/docs/agent-connectors/asana/add-redirect-url.gif") so the screenshot
shows the Asana Developer Console redirect-URL step.
In `@src/components/templates/agent-connectors/_setup-googlecalendar.mdx`:
- Line 22: The image markdown line lacks alt text; update the image tag that
references
"@/assets/docs/agent-connectors/googlecalendar/use-own-credentials-redirect-uri.png"
to include a concise, descriptive alt string (e.g., "Google Calendar OAuth
redirect URI configuration screenshot") by inserting the alt text between the
square brackets so the markdown becomes ;
ensure the alt text clearly describes the image content for accessibility.
---
Outside diff comments:
In `@src/components/templates/agent-connectors/_setup-confluence.mdx`:
- Line 2: The imported image variable useOwnCredentialsImg is not being used and
the inline image tag lacks alt text; update the image element that currently
embeds the PNG (the one before the sections using images at lines similar to the
other two instances) to use the imported variable useOwnCredentialsImg as its
src and add a descriptive alt attribute (e.g., alt="Confluence: Use your own
credentials redirect URI") to match the usage pattern found for the other images
in this file.
In `@src/components/templates/agent-connectors/_setup-intercom.mdx`:
- Line 2: Replace the hardcoded image src and missing alt attribute with the
imported variable: use the imported symbol useOwnCredentialsImg as the src for
the image element that currently lacks alt text, and add a concise, descriptive
alt attribute (e.g., "Intercom redirect URI settings screenshot") to that img
tag so it matches the usage style of the image at the other location using
useOwnCredentialsImg.
In `@src/components/templates/agent-connectors/_setup-monday.mdx`:
- Line 2: Replace the hardcoded image src on the page with the imported variable
useOwnCredentialsImg and add descriptive alt text; specifically locate the img
element referenced on the page (currently not using useOwnCredentialsImg) and
change its src to useOwnCredentialsImg and include an appropriate alt attribute
(e.g., alt="Use your own credentials - redirect URI example") so the import is
used and accessibility is improved.
In `@src/components/templates/agent-connectors/_setup-notion.mdx`:
- Line 2: The imported image variable useOwnCredentialsImg is not being used and
the image tag near the top of the document lacks alt text; replace the hardcoded
image source there with the imported useOwnCredentialsImg and add meaningful alt
text (e.g., "Use your own credentials redirect URI") so the import is actually
referenced and the image is accessible/accessible to screen readers; verify the
same pattern is used consistently like the image at line 33.
In `@src/components/templates/agent-connectors/_setup-zoom.mdx`:
- Line 2: The imported image variable useOwnCredentialsImg is unused and the
inline Markdown image lacks alt text; replace the Markdown image with the
React-style image tag used elsewhere: render <img src={useOwnCredentialsImg}
alt="Zoom: use your own credentials redirect URI" /> (consistent with other
images in this file such as those around useOwnCredentialsImg usage) so the
import is used and the image has descriptive alt text; alternatively, if you
prefer Markdown, remove the unused import useOwnCredentialsImg and change the
Markdown image to include alt text like  .
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: da33d8f0-17c4-4fe1-b9be-a434e4b6b631
⛔ Files ignored due to path filters (14)
src/assets/docs/agent-connectors/airtable/use-own-credentials-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/confluence/use-own-credentials-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/dropbox/use-own-credentials-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/github/use-own-credentials-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/gmail/use-own-credentials-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/gong/use-own-credentials-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/googlecalendar/use-own-credentials-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/intercom/use-own-credentials-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/jira/use-own-credentials-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/monday/use-own-credentials-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/servicenow/use-own-credentials-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/snowflake/use-own-credentials-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/zendesk/use-own-credentials-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/zoom/use-own-credentials-redirect-uri.pngis excluded by!**/*.png
📒 Files selected for processing (8)
src/components/templates/agent-connectors/_setup-airtable.mdxsrc/components/templates/agent-connectors/_setup-asana.mdxsrc/components/templates/agent-connectors/_setup-confluence.mdxsrc/components/templates/agent-connectors/_setup-googlecalendar.mdxsrc/components/templates/agent-connectors/_setup-intercom.mdxsrc/components/templates/agent-connectors/_setup-monday.mdxsrc/components/templates/agent-connectors/_setup-notion.mdxsrc/components/templates/agent-connectors/_setup-zoom.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-googlecalendar.mdxsrc/components/templates/agent-connectors/_setup-airtable.mdxsrc/components/templates/agent-connectors/_setup-confluence.mdxsrc/components/templates/agent-connectors/_setup-notion.mdxsrc/components/templates/agent-connectors/_setup-zoom.mdxsrc/components/templates/agent-connectors/_setup-intercom.mdxsrc/components/templates/agent-connectors/_setup-asana.mdxsrc/components/templates/agent-connectors/_setup-monday.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-googlecalendar.mdxsrc/components/templates/agent-connectors/_setup-airtable.mdxsrc/components/templates/agent-connectors/_setup-confluence.mdxsrc/components/templates/agent-connectors/_setup-notion.mdxsrc/components/templates/agent-connectors/_setup-zoom.mdxsrc/components/templates/agent-connectors/_setup-intercom.mdxsrc/components/templates/agent-connectors/_setup-asana.mdxsrc/components/templates/agent-connectors/_setup-monday.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-googlecalendar.mdxsrc/components/templates/agent-connectors/_setup-airtable.mdxsrc/components/templates/agent-connectors/_setup-confluence.mdxsrc/components/templates/agent-connectors/_setup-notion.mdxsrc/components/templates/agent-connectors/_setup-zoom.mdxsrc/components/templates/agent-connectors/_setup-intercom.mdxsrc/components/templates/agent-connectors/_setup-asana.mdxsrc/components/templates/agent-connectors/_setup-monday.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-googlecalendar.mdxsrc/components/templates/agent-connectors/_setup-airtable.mdxsrc/components/templates/agent-connectors/_setup-confluence.mdxsrc/components/templates/agent-connectors/_setup-notion.mdxsrc/components/templates/agent-connectors/_setup-zoom.mdxsrc/components/templates/agent-connectors/_setup-intercom.mdxsrc/components/templates/agent-connectors/_setup-asana.mdxsrc/components/templates/agent-connectors/_setup-monday.mdx
🧠 Learnings (12)
📓 Common learnings
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: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: scripts/sync-agent-connectors.js:0-0
Timestamp: 2026-02-26T07:18:51.377Z
Learning: In src/content/docs/reference/agent-connectors/**/*.mdx files, sidebar.label frontmatter is not required because the sidebar configuration references the agent-connectors directory for auto-generation. Navigation ordering and grouping are managed centrally in the sidebar configuration file.
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 448
File: src/content/docs/reference/agent-connectors/googlemeet.mdx:1-87
Timestamp: 2026-02-26T07:20:46.903Z
Learning: For auto-generated agent connector documentation pages in src/content/docs/reference/agent-connectors/, the "what's next" signal requirement (next: frontmatter link, <LinkCard>, or concluding paragraph) does not apply. These are reference pages generated by scripts/sync-agent-connectors.js and serve as lookup resources rather than sequential guides.
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: 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: 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
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: .cursor/rules/documentation-guide.mdc:0-0
Timestamp: 2026-01-13T12:48:11.566Z
Learning: Applies to **/*.mdx : Store images under `src/assets/docs/**` and reference with the `@/assets/docs/` prefix
📚 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-googlecalendar.mdxsrc/components/templates/agent-connectors/_setup-airtable.mdxsrc/components/templates/agent-connectors/_setup-confluence.mdxsrc/components/templates/agent-connectors/_setup-zoom.mdxsrc/components/templates/agent-connectors/_setup-intercom.mdxsrc/components/templates/agent-connectors/_setup-asana.mdxsrc/components/templates/agent-connectors/_setup-monday.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-googlecalendar.mdxsrc/components/templates/agent-connectors/_setup-airtable.mdxsrc/components/templates/agent-connectors/_setup-confluence.mdxsrc/components/templates/agent-connectors/_setup-notion.mdxsrc/components/templates/agent-connectors/_setup-zoom.mdxsrc/components/templates/agent-connectors/_setup-intercom.mdxsrc/components/templates/agent-connectors/_setup-asana.mdxsrc/components/templates/agent-connectors/_setup-monday.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-googlecalendar.mdxsrc/components/templates/agent-connectors/_setup-airtable.mdxsrc/components/templates/agent-connectors/_setup-confluence.mdxsrc/components/templates/agent-connectors/_setup-notion.mdxsrc/components/templates/agent-connectors/_setup-zoom.mdxsrc/components/templates/agent-connectors/_setup-intercom.mdxsrc/components/templates/agent-connectors/_setup-asana.mdxsrc/components/templates/agent-connectors/_setup-monday.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-googlecalendar.mdxsrc/components/templates/agent-connectors/_setup-airtable.mdxsrc/components/templates/agent-connectors/_setup-confluence.mdxsrc/components/templates/agent-connectors/_setup-notion.mdxsrc/components/templates/agent-connectors/_setup-zoom.mdxsrc/components/templates/agent-connectors/_setup-intercom.mdxsrc/components/templates/agent-connectors/_setup-asana.mdxsrc/components/templates/agent-connectors/_setup-monday.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-airtable.mdxsrc/components/templates/agent-connectors/_setup-confluence.mdxsrc/components/templates/agent-connectors/_setup-notion.mdxsrc/components/templates/agent-connectors/_setup-zoom.mdxsrc/components/templates/agent-connectors/_setup-monday.mdx
📚 Learning: 2026-02-26T07:18:51.377Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 448
File: scripts/sync-agent-connectors.js:0-0
Timestamp: 2026-02-26T07:18:51.377Z
Learning: In src/content/docs/reference/agent-connectors/**/*.mdx files, sidebar.label frontmatter is not required because the sidebar configuration references the agent-connectors directory for auto-generation. Navigation ordering and grouping are managed centrally in the sidebar configuration file.
Applied to files:
src/components/templates/agent-connectors/_setup-airtable.mdxsrc/components/templates/agent-connectors/_setup-confluence.mdxsrc/components/templates/agent-connectors/_setup-notion.mdxsrc/components/templates/agent-connectors/_setup-zoom.mdxsrc/components/templates/agent-connectors/_setup-intercom.mdxsrc/components/templates/agent-connectors/_setup-asana.mdxsrc/components/templates/agent-connectors/_setup-monday.mdx
📚 Learning: 2026-02-26T07:20:46.903Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 448
File: src/content/docs/reference/agent-connectors/googlemeet.mdx:1-87
Timestamp: 2026-02-26T07:20:46.903Z
Learning: For auto-generated agent connector documentation pages in src/content/docs/reference/agent-connectors/, the "what's next" signal requirement (next: frontmatter link, <LinkCard>, or concluding paragraph) does not apply. These are reference pages generated by scripts/sync-agent-connectors.js and serve as lookup resources rather than sequential guides.
Applied to files:
src/components/templates/agent-connectors/_setup-airtable.mdxsrc/components/templates/agent-connectors/_setup-confluence.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-airtable.mdxsrc/components/templates/agent-connectors/_setup-confluence.mdxsrc/components/templates/agent-connectors/_setup-zoom.mdxsrc/components/templates/agent-connectors/_setup-monday.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 : Reference images in MDX files with proper paths using `@/assets/docs/` prefix and include alt text
Applied to files:
src/components/templates/agent-connectors/_setup-zoom.mdxsrc/components/templates/agent-connectors/_setup-intercom.mdxsrc/components/templates/agent-connectors/_setup-monday.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-intercom.mdx
📚 Learning: 2026-01-13T12:48:11.566Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursor/rules/documentation-guide.mdc:0-0
Timestamp: 2026-01-13T12:48:11.566Z
Learning: Applies to **/*.{md,mdx} : Update code examples when APIs or behaviors change
Applied to files:
src/components/templates/agent-connectors/_setup-monday.mdx
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 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-airtable.mdx`:
- Line 14: The Markdown image on line 14 uses backticks and must follow the
project's MDX import pattern: add an import for the image at the top of the file
(as done for the images referenced around lines 20 and 38) and then replace the
backticked markdown with an inline JSX image - e.g., use the imported identifier
in an <img> tag with an appropriate alt text (matching the style of the other
images in this file).
In `@src/components/templates/agent-connectors/_setup-linear.mdx`:
- Line 10: The image markdown line currently wraps the image URL in backticks
which produces inline code and prevents rendering; edit the image reference
shown (the line starting with )
to remove the surrounding backticks so the URL is a plain path (e.g.,
), ensuring the image renders correctly.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: b8613c62-047a-4b1f-8639-f529ee74d274
📒 Files selected for processing (2)
src/components/templates/agent-connectors/_setup-airtable.mdxsrc/components/templates/agent-connectors/_setup-linear.mdx
📜 Review details
🧰 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-linear.mdxsrc/components/templates/agent-connectors/_setup-airtable.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-linear.mdxsrc/components/templates/agent-connectors/_setup-airtable.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-linear.mdxsrc/components/templates/agent-connectors/_setup-airtable.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-linear.mdxsrc/components/templates/agent-connectors/_setup-airtable.mdx
🧠 Learnings (16)
📓 Common learnings
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: 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
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 463
File: src/content/docs/agent-auth/providers.mdx:35-73
Timestamp: 2026-03-05T11:29:12.786Z
Learning: In `src/content/docs/agent-auth/providers.mdx`, the `<Card>` components use `icon=" "` (a space) intentionally. This is a deliberate UX choice to render consistent colored boxes across all cards, because only some Starlight icon names resolve to actual icons while others do not. Do not flag `icon=" "` as a placeholder issue on this file.
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 448
File: scripts/sync-agent-connectors.js:0-0
Timestamp: 2026-02-26T07:18:51.377Z
Learning: In src/content/docs/reference/agent-connectors/**/*.mdx files, sidebar.label frontmatter is not required because the sidebar configuration references the agent-connectors directory for auto-generation. Navigation ordering and grouping are managed centrally in the sidebar configuration file.
📚 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-linear.mdxsrc/components/templates/agent-connectors/_setup-airtable.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-linear.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-linear.mdxsrc/components/templates/agent-connectors/_setup-airtable.mdx
📚 Learning: 2026-02-26T07:20:46.903Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 448
File: src/content/docs/reference/agent-connectors/googlemeet.mdx:1-87
Timestamp: 2026-02-26T07:20:46.903Z
Learning: For auto-generated agent connector documentation pages in src/content/docs/reference/agent-connectors/, the "what's next" signal requirement (next: frontmatter link, <LinkCard>, or concluding paragraph) does not apply. These are reference pages generated by scripts/sync-agent-connectors.js and serve as lookup resources rather than sequential guides.
Applied to files:
src/components/templates/agent-connectors/_setup-linear.mdx
📚 Learning: 2026-02-26T07:18:51.377Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 448
File: scripts/sync-agent-connectors.js:0-0
Timestamp: 2026-02-26T07:18:51.377Z
Learning: In src/content/docs/reference/agent-connectors/**/*.mdx files, sidebar.label frontmatter is not required because the sidebar configuration references the agent-connectors directory for auto-generation. Navigation ordering and grouping are managed centrally in the sidebar configuration file.
Applied to files:
src/components/templates/agent-connectors/_setup-linear.mdx
📚 Learning: 2026-01-13T12:48:11.566Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursor/rules/documentation-guide.mdc:0-0
Timestamp: 2026-01-13T12:48:11.566Z
Learning: Applies to **/*.{md,mdx} : Provide meaningful alt text for images in documentation
Applied to files:
src/components/templates/agent-connectors/_setup-linear.mdxsrc/components/templates/agent-connectors/_setup-airtable.mdx
📚 Learning: 2026-03-05T11:29:12.786Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 463
File: src/content/docs/agent-auth/providers.mdx:35-73
Timestamp: 2026-03-05T11:29:12.786Z
Learning: In `src/content/docs/agent-auth/providers.mdx`, the `<Card>` components use `icon=" "` (a space) intentionally. This is a deliberate UX choice to render consistent colored boxes across all cards, because only some Starlight icon names resolve to actual icons while others do not. Do not flag `icon=" "` as a placeholder issue on this file.
Applied to files:
src/components/templates/agent-connectors/_setup-linear.mdxsrc/components/templates/agent-connectors/_setup-airtable.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 : Reference images in MDX files with proper paths using `@/assets/docs/` prefix and include alt text
Applied to files:
src/components/templates/agent-connectors/_setup-linear.mdxsrc/components/templates/agent-connectors/_setup-airtable.mdx
📚 Learning: 2026-01-13T12:48:11.566Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursor/rules/documentation-guide.mdc:0-0
Timestamp: 2026-01-13T12:48:11.566Z
Learning: Applies to **/*.{md,mdx} : Always include alt text and brief context near images in documentation
Applied to files:
src/components/templates/agent-connectors/_setup-linear.mdxsrc/components/templates/agent-connectors/_setup-airtable.mdx
📚 Learning: 2026-03-03T10:47:47.162Z
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 **/*.{md,mdx} : Use descriptive link text like 'See permission flags' not 'click here'. Prefer relative links for internal pages; include anchors for sections. Reference APIs consistently with backticks for code.
Applied to files:
src/components/templates/agent-connectors/_setup-linear.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 descriptive link text and include proper heading structure for accessibility
Applied to files:
src/components/templates/agent-connectors/_setup-linear.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-linear.mdxsrc/components/templates/agent-connectors/_setup-airtable.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-linear.mdxsrc/components/templates/agent-connectors/_setup-airtable.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-airtable.mdx
📚 Learning: 2026-01-13T12:48:11.566Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursor/rules/documentation-guide.mdc:0-0
Timestamp: 2026-01-13T12:48:11.566Z
Learning: Applies to src/assets/docs/** : Use descriptive image filenames (e.g., `1-email-delivery-method.png`)
Applied to files:
src/components/templates/agent-connectors/_setup-airtable.mdx
Pranesh-Raghu
changed the title
There was a problem hiding this comment.
Actionable comments posted: 8
🤖 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-google-looker.mdx`:
- Around line 13-27: The file mixes image syntaxes: a JSX image using
useOwnCredentialsImg.src in the <img ... /> at the "Set up auth redirects"
section and Markdown image links (e.g., the two occurrences with
"@/assets/docs/agent-connectors/...") — make them consistent by choosing one
approach and converting the others; either replace the JSX <img
src={useOwnCredentialsImg.src} ... /> with the equivalent Markdown image
reference (and remove the useOwnCredentialsImg import if unused) or convert the
Markdown images to JSX <img src={...} alt="..." /> and import the assets
(ensuring names match, e.g., useOwnCredentialsImg or similar) so all image
references use the same syntax throughout the file.
- Around line 3-4: Remove the unused image imports oauthWebAppImg and
addRedirectUriImg from the top of the file and any leftover references; since
the MDX uses direct markdown image paths, delete the import lines importing
oauthWebAppImg and addRedirectUriImg and verify there are no other uses of those
symbols in the document.
In `@src/components/templates/agent-connectors/index.ts`:
- Line 12: The export ordering is out of alphabetical sequence: move the line
exporting SetupGoogleLookerSection so it appears after the export for
SetupGoogleFormsSection and before SetupGoogleMeetsSection; update the export
list in this file by relocating the "export { default as
SetupGoogleLookerSection } from './_setup-google-looker.mdx'" statement to the
correct alphabetical position next to SetupGoogleFormsSection to restore
consistent ordering.
In `@src/content/docs/reference/agent-connectors/apollo.mdx`:
- Around line 75-76: The file imports unused symbols Accordion and
AccordionItem; remove those imports to eliminate dead code. Locate the import
statement that includes Accordion and AccordionItem (the line importing from
'accessible-astro-components') and delete Accordion and AccordionItem from that
import so only used symbols like SetupApolloSection remain imported, or remove
the entire import line if nothing from 'accessible-astro-components' is needed.
- Line 74: The import statement that brings in Code alongside Card, CardGrid,
Tabs, TabItem, Badge, Steps, and Aside from '@astrojs/starlight/components' is
importing an unused symbol (Code); remove Code from that import list so only the
actually used components remain (e.g., keep Card, CardGrid, Tabs, TabItem,
Badge, Steps, Aside) to eliminate the unused import warning.
- Around line 173-175: The "## Tool list" heading is redundant because each tool
is already a top-level section (e.g., "## `apollo_contacts_search`"); remove the
"## Tool list" heading or replace it with a brief one-line intro paragraph
before the individual tool headings so the TOC remains clean and each tool stays
its own section—look for the literal heading "## Tool list" and the following
"## `apollo_contacts_search`" to make the change.
In `@src/content/docs/reference/agent-connectors/google_looker.mdx`:
- Around line 173-175: Remove the redundant "Tool list" heading by either
deleting the `## Tool list` line or converting it to a short introductory
sentence placed before the `## `google_looker_dashboards_all`` heading; ensure
the remaining content starts with the tool heading
`google_looker_dashboards_all` and that any explanatory text (if kept) is plain
paragraph text rather than an H2 heading.
- Around line 74-75: Remove the unused imports to clean up the module: delete
Code, Accordion, and AccordionItem from the import statements where they are
currently included (the import line that brings in Card, CardGrid, Tabs,
TabItem, Badge, Steps, Aside, Code and the separate import for Accordion,
AccordionItem). Keep only the components actually used (e.g., Card, CardGrid,
Tabs, TabItem, Badge, Steps, Aside) so references to Code, Accordion, and
AccordionItem are removed from the file imports.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: 2b2d305f-c63d-4b30-bdad-7e28b6a9dec3
⛔ Files ignored due to path filters (2)
src/assets/docs/agent-connectors/apollo/use-own-credentials-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/google_looker/use-own-credentials-redirect-uri.pngis excluded by!**/*.png
📒 Files selected for processing (5)
src/components/templates/agent-connectors/_setup-apollo.mdxsrc/components/templates/agent-connectors/_setup-google-looker.mdxsrc/components/templates/agent-connectors/index.tssrc/content/docs/reference/agent-connectors/apollo.mdxsrc/content/docs/reference/agent-connectors/google_looker.mdx
📜 Review details
🧰 Additional context used
📓 Path-based instructions (11)
**/*.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/content/docs/reference/agent-connectors/google_looker.mdxsrc/components/templates/agent-connectors/_setup-apollo.mdxsrc/components/templates/agent-connectors/_setup-google-looker.mdxsrc/content/docs/reference/agent-connectors/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/content/docs/reference/agent-connectors/google_looker.mdxsrc/components/templates/agent-connectors/_setup-apollo.mdxsrc/components/templates/agent-connectors/_setup-google-looker.mdxsrc/content/docs/reference/agent-connectors/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/content/docs/reference/agent-connectors/google_looker.mdxsrc/components/templates/agent-connectors/_setup-apollo.mdxsrc/components/templates/agent-connectors/_setup-google-looker.mdxsrc/content/docs/reference/agent-connectors/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/content/docs/reference/agent-connectors/google_looker.mdxsrc/components/templates/agent-connectors/_setup-apollo.mdxsrc/components/templates/agent-connectors/_setup-google-looker.mdxsrc/content/docs/reference/agent-connectors/apollo.mdx
src/content/docs/**/*.{md,mdx}
📄 CodeRabbit inference engine (CLAUDE.md)
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.
Proactively address common setup and configuration problems. Keep code examples simple, self-contained, and exportable.
Use imperative for procedures: 'Install', 'Create', 'Run', 'Configure', 'Test'. Front-load the action and start sentences with the verb or key concept.
Explain why when useful. Briefly justify non-obvious steps. Prefer examples over theory; show the common path first and link to details.
Every page MUST include frontmatter with at least:title(≤60 characters),description(≤160 characters), andsidebar.label(1-3 words). Usesidebar.orderonly when navigation ordering matters. Useprev/nextfor sequential guides; useseeAlsofor related guides. EnabletableOfContentsfor longer pages with multiple major sections.
Opening paragraphs (1-3) MUST state what users will accomplish, when/why they need it, and preview the workflow using direct instructional language
The Steps component requires a single continuous ordered list. Steps must start at column 0 with no leading spaces. Continuation content (images, text) must be indented with exactly 3 spaces. Sub-bullet lists use 3 spaces with no blank line before bullets. No blank line immediately after Steps opening tag.
Documentation must be organized into logical sections (FSA, SSO, Directory/SCIM, Connect, M2M, Guides, Reference) with proper sidebar configuration and navigation structure
Files:
src/content/docs/reference/agent-connectors/google_looker.mdxsrc/content/docs/reference/agent-connectors/apollo.mdx
**/*.{js,ts,tsx,jsx,py,java,cs,go,cpp,c,rb,php,swift,kt,scala,rs,m,mm,groovy,gradle,xml,json}
📄 CodeRabbit inference engine (.cursor/rules/comment-standards.mdc)
Comments should not duplicate the code - avoid comments that simply restate what the code does; comments should add value beyond what's obvious from reading the code
Files:
src/components/templates/agent-connectors/index.ts
**/*.{js,ts,tsx,jsx,py,java,cs,go,cpp,c,rb,php,swift,kt,scala,rs,m,mm,groovy}
📄 CodeRabbit inference engine (.cursor/rules/comment-standards.mdc)
**/*.{js,ts,tsx,jsx,py,java,cs,go,cpp,c,rb,php,swift,kt,scala,rs,m,mm,groovy}: Good comments do not excuse unclear code - refactor the code to be self-explanatory instead of using comments to explain poorly written code; use better variable names, function names, and code structure
Comments should dispel confusion, not cause it - ensure comments clarify rather than obscure the code's purpose; avoid cryptic or joke comments
Explain unidiomatic code in comments - comment on code that might seem unnecessary or redundant and document why you chose a specific pattern over more common alternatives, especially when it deviates from team conventions
Provide links to the original source of copied code - always attribute code copied from external sources with URLs to Stack Overflow answers, GitHub repositories, or documentation
Include links to external references where helpful - reference standards, RFCs, and official documentation; link to relevant specifications when implementing protocols
Add comments when fixing bugs - document bug fixes with context about the issue, reference issue trackers and bug reports, and explain workarounds and their limitations
Use comments to mark incomplete implementations - use standard formats for TODO, FIXME, and NOTE comments with context about what needs to be done and reference issue trackers when possible
Always document public APIs with function/class comments - explain the purpose, parameters, return values, and exceptions; include usage examples for complex functions
Include file headers with copyright information, license, and authorship - provide a brief description of the file's purpose and document dependencies and requirements
Files:
src/components/templates/agent-connectors/index.ts
**/*.{js,ts,tsx,jsx}
📄 CodeRabbit inference engine (.cursor/rules/comment-standards.mdc)
Use JSDoc standards for all function, class, and complex logic comments in JavaScript/TypeScript - include parameter descriptions (
@param), return values (@returns), types (@type), and descriptions; document exceptions and edge cases
Files:
src/components/templates/agent-connectors/index.ts
**/*.{ts,tsx,js,jsx,py,go,java}
📄 CodeRabbit inference engine (CLAUDE.md)
Comments should not duplicate the code. Do not use comments to explain poorly written code; instead, use better variable names and structure. Comments should dispel confusion, not cause it.
Files:
src/components/templates/agent-connectors/index.ts
**/*.{ts,tsx,js,jsx,java,py}
📄 CodeRabbit inference engine (CLAUDE.md)
Use JSDoc/JavaDoc/docstring standards for function, class, and complex logic comments. Include parameter descriptions, return values, types, and descriptions. Document exceptions and edge cases.
Files:
src/components/templates/agent-connectors/index.ts
**/*.{ts,tsx,js,jsx,java,py,go}
📄 CodeRabbit inference engine (CLAUDE.md)
**/*.{ts,tsx,js,jsx,java,py,go}: Add comments when fixing bugs; reference issue trackers. Use standard formats for TODO, FIXME, and NOTE comments.
Include links to external references in comments where helpful (standards, RFCs, official documentation)
Files:
src/components/templates/agent-connectors/index.ts
**/*.{ts,js,mjs}
⚙️ CodeRabbit configuration file
**/*.{ts,js,mjs}: Do NOT enforce code-commenting style rules on these files.
Specifically, do not flag:
- Comments that "duplicate" or restate what the code does.
- Missing comments on bug fixes, workarounds, or issue references.
- Missing inline documentation or explanatory comments.
Code comments are at the author's discretion.
Files:
src/components/templates/agent-connectors/index.ts
🧠 Learnings (38)
📓 Common learnings
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/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: scripts/sync-agent-connectors.js:0-0
Timestamp: 2026-02-26T07:18:51.377Z
Learning: In src/content/docs/reference/agent-connectors/**/*.mdx files, sidebar.label frontmatter is not required because the sidebar configuration references the agent-connectors directory for auto-generation. Navigation ordering and grouping are managed centrally in the sidebar configuration file.
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 448
File: src/content/docs/reference/agent-connectors/googlemeet.mdx:1-87
Timestamp: 2026-02-26T07:20:46.903Z
Learning: For auto-generated agent connector documentation pages in src/content/docs/reference/agent-connectors/, the "what's next" signal requirement (next: frontmatter link, <LinkCard>, or concluding paragraph) does not apply. These are reference pages generated by scripts/sync-agent-connectors.js and serve as lookup resources rather than sequential guides.
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: 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
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 463
File: src/content/docs/agent-auth/providers.mdx:35-73
Timestamp: 2026-03-05T11:29:12.786Z
Learning: In `src/content/docs/agent-auth/providers.mdx`, the `<Card>` components use `icon=" "` (a space) intentionally. This is a deliberate UX choice to render consistent colored boxes across all cards, because only some Starlight icon names resolve to actual icons while others do not. Do not flag `icon=" "` as a placeholder issue on this file.
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.
📚 Learning: 2026-02-26T07:21:32.951Z
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:32.951Z
Learning: For agent-connectors reference MDX files, use H2 headings (##) for tool sections (e.g., googlesheets_create_spreadsheet, googlesheets_get_values) so they appear in the table of contents. This is a deliberate UX choice and should not be flagged as a hierarchy issue.
Applied to files:
src/content/docs/reference/agent-connectors/google_looker.mdxsrc/content/docs/reference/agent-connectors/apollo.mdx
📚 Learning: 2026-02-26T07:22:49.128Z
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:49.128Z
Learning: For MDX files under src/content/docs/reference/agent-connectors, parameter tables are auto-generated from JSON API responses by scripts/sync-agent-connectors.js. Do not manually edit the generated MDX files. Update scripts/sync-agent-connectors.js to output a four-column table with headers Name | Type | Required | Description for all parameter tables, ensuring consistency with the coding guidelines. This pattern should apply to all MDX files in that directory.
Applied to files:
src/content/docs/reference/agent-connectors/google_looker.mdxsrc/content/docs/reference/agent-connectors/apollo.mdx
📚 Learning: 2026-02-26T07:20:42.107Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 448
File: src/content/docs/reference/agent-connectors/googlemeet.mdx:1-87
Timestamp: 2026-02-26T07:20:42.107Z
Learning: In src/content/docs/reference/agent-connectors/**, these auto-generated agent connector reference pages (e.g., googlemeet.mdx) are lookup resources. Do not require or enforce the 'what's next' signal (next link, LinkCard, or concluding paragraph) for these pages; treat them as non-sequential references produced by scripts (scripts/sync-agent-connectors.js).
Applied to files:
src/content/docs/reference/agent-connectors/google_looker.mdxsrc/content/docs/reference/agent-connectors/apollo.mdx
📚 Learning: 2026-02-26T07:23:24.179Z
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:24.179Z
Learning: Do not enforce the 160-character description limit for MDX files under src/content/docs/reference/agent-connectors/. These files are auto-generated from API payloads via scripts/sync-agent-connectors.js and may contain longer descriptions sourced from the data.
Applied to files:
src/content/docs/reference/agent-connectors/google_looker.mdxsrc/content/docs/reference/agent-connectors/apollo.mdx
📚 Learning: 2026-02-26T07:18:41.518Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 448
File: scripts/sync-agent-connectors.js:0-0
Timestamp: 2026-02-26T07:18:41.518Z
Learning: For MDX files under src/content/docs/reference/agent-connectors, the sidebar.label frontmatter is not required because navigation is auto-generated from this directory via the central sidebar config. Do not rely on or modify sidebar.label in these files; ensure ordering and grouping are defined in the shared sidebar configuration.
Applied to files:
src/content/docs/reference/agent-connectors/google_looker.mdxsrc/content/docs/reference/agent-connectors/apollo.mdx
📚 Learning: 2026-03-03T13:35:47.638Z
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:47.638Z
Learning: In Agent Connectors documentation (src/content/docs/reference/agent-connectors/**/*.mdx), only Python SDK examples for Agent Actions/Agent Connectors should be required for now. Do not enforce or require multi-language SDK code examples (Node.js, Python, Go, Java) until the respective SDKs support Agent Actions. Once supported, you can add and require other languages in those docs. This guideline applies to all files under the agent-connectors documentation path.
Applied to files:
src/content/docs/reference/agent-connectors/google_looker.mdxsrc/content/docs/reference/agent-connectors/apollo.mdx
📚 Learning: 2026-02-26T07:21:09.133Z
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:09.133Z
Learning: For any agent connector documentation files located in src/content/docs/reference/agent-connectors/, prefer using CDN URLs for connector logos (https://cdn.scalekit.cloud/sk-connect/assets/provider-icons/) instead of inlining or storing images in local assets (e.g., src/assets/docs/). This should override the general guideline to use local assets for this specific docs section. Apply this pattern to all mdx files in that directory; use the CDN-hosted logo URLs in image elements or logo references.
Applied to files:
src/content/docs/reference/agent-connectors/google_looker.mdxsrc/content/docs/reference/agent-connectors/apollo.mdx
📚 Learning: 2026-01-30T18:18:50.883Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 415
File: src/content/docs/authenticate/fsa/multiapp/manage-apps.mdx:31-49
Timestamp: 2026-01-30T18:18:50.883Z
Learning: In all Scalekit documentation files (MDX), treat the terms 'Applications', 'Single Page Application (SPA)', 'Native Application', and 'Web Application' as proper nouns and preserve their capitalization in headings and body text. Ensure these terms remain capitalized even when used in sentence case or within prose.
Applied to files:
src/content/docs/reference/agent-connectors/google_looker.mdxsrc/content/docs/reference/agent-connectors/apollo.mdx
📚 Learning: 2026-02-04T12:47:16.544Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 412
File: src/content/docs/dev-kit/tools/scalekit-dryrun.mdx:1-23
Timestamp: 2026-02-04T12:47:16.544Z
Learning: In scalekit-inc/developer-docs, the MDX frontmatter field order is required only when the sidebar configuration points to a directory (for auto-generation). If the sidebar.config.ts references a specific file path, the order field is not required. Apply this check to all MDX files under src/content/docs: if a file contributes to an auto-generated sidebar (directory path), ensure order is present; if it’s linked to a concrete file, order can be omitted. Use sidebar.config.ts to determine whether a given MDX file falls under directory-based vs file-specific sidebar references.
Applied to files:
src/content/docs/reference/agent-connectors/google_looker.mdxsrc/content/docs/reference/agent-connectors/apollo.mdx
📚 Learning: 2026-02-25T08:57:12.201Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 444
File: src/content/docs/agent-auth/quickstart.mdx:2-10
Timestamp: 2026-02-25T08:57:12.201Z
Learning: In Scalekit developer-docs (Astro Starlight), do not auto-suggest adding tableOfContents in frontmatter unless the user explicitly overrides the default behavior. The default enables tableOfContents with minHeadingLevel 2 and maxHeadingLevel 3. Only set tableOfContents when you want to customize heading levels or disable it entirely; otherwise omit it for other docs.
Applied to files:
src/content/docs/reference/agent-connectors/google_looker.mdxsrc/content/docs/reference/agent-connectors/apollo.mdx
📚 Learning: 2026-02-25T13:04:27.491Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 444
File: src/content/docs/agent-auth/start-agent-auth-coding-agents.mdx:9-17
Timestamp: 2026-02-25T13:04:27.491Z
Learning: Allow page-level CSS overrides in MDX frontmatter (head: style) for readability and engagement, even if it customizes typography beyond defaults. This applies to per-page UX decisions, including heading sizes and style tweaks, but keep overrides purposeful, accessible, and within the repository's design guidelines. Use these overrides sparingly and document the rationale for maintainability.
Applied to files:
src/content/docs/reference/agent-connectors/google_looker.mdxsrc/content/docs/reference/agent-connectors/apollo.mdx
📚 Learning: 2026-03-05T11:29:08.125Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 463
File: src/content/docs/agent-auth/providers.mdx:35-73
Timestamp: 2026-03-05T11:29:08.125Z
Learning: In src/content/docs/agent-auth/providers.mdx, the Card components intentionally use icon=" " (a space) to render consistent colored boxes since some Starlight icon names resolve to icons and others do not. Do not flag icon=" " as a placeholder issue for this file; treat this as a deliberate UX choice specific to this MDX page and avoid raising a placeholder-icon warning here.
Applied to files:
src/content/docs/reference/agent-connectors/google_looker.mdxsrc/content/docs/reference/agent-connectors/apollo.mdx
📚 Learning: 2026-03-09T07:27:56.794Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 469
File: src/content/docs/guides/integrations/scim-integrations/azure-scim.mdx:95-107
Timestamp: 2026-03-09T07:27:56.794Z
Learning: Do not enforce the 3-space indentation rule for Steps component content as a hard style rule in MDX files under src/content/docs/**/*.mdx. Only flag/rectify it if it causes visible rendering problems in the UI. Otherwise, allow current formatting; apply this rule only when rendering issues are observed and document any fixes.
Applied to files:
src/content/docs/reference/agent-connectors/google_looker.mdxsrc/content/docs/reference/agent-connectors/apollo.mdx
📚 Learning: 2026-03-09T07:32:38.426Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 467
File: src/content/docs/sso/guides/sso-user-attributes.mdx:108-148
Timestamp: 2026-03-09T07:32:38.426Z
Learning: In MDX code samples under src/content/docs (and similar conceptual snippets in scalekit-inc/developer-docs), when an example's sole purpose is to show how to access a specific value (e.g., reading JWT claims after token validation), omit error/non-happy-path handling to keep the snippet focused. Do not flag the absence of error paths in narrowly scoped conceptual snippets.
Applied to files:
src/content/docs/reference/agent-connectors/google_looker.mdxsrc/content/docs/reference/agent-connectors/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/content/docs/reference/agent-connectors/google_looker.mdxsrc/components/templates/agent-connectors/_setup-apollo.mdxsrc/components/templates/agent-connectors/_setup-google-looker.mdxsrc/content/docs/reference/agent-connectors/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/content/docs/reference/agent-connectors/google_looker.mdxsrc/components/templates/agent-connectors/_setup-apollo.mdxsrc/components/templates/agent-connectors/_setup-google-looker.mdxsrc/content/docs/reference/agent-connectors/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/index.tssrc/components/templates/agent-connectors/_setup-apollo.mdxsrc/components/templates/agent-connectors/_setup-google-looker.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/index.tssrc/components/templates/agent-connectors/_setup-apollo.mdxsrc/components/templates/agent-connectors/_setup-google-looker.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/index.tssrc/components/templates/agent-connectors/_setup-apollo.mdxsrc/components/templates/agent-connectors/_setup-google-looker.mdx
📚 Learning: 2026-02-26T07:18:51.377Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 448
File: scripts/sync-agent-connectors.js:0-0
Timestamp: 2026-02-26T07:18:51.377Z
Learning: In src/content/docs/reference/agent-connectors/**/*.mdx files, sidebar.label frontmatter is not required because the sidebar configuration references the agent-connectors directory for auto-generation. Navigation ordering and grouping are managed centrally in the sidebar configuration file.
Applied to files:
src/components/templates/agent-connectors/index.tssrc/components/templates/agent-connectors/_setup-apollo.mdxsrc/components/templates/agent-connectors/_setup-google-looker.mdx
📚 Learning: 2026-03-03T10:47:47.162Z
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/components/templates/_*.{tsx,jsx,astro} : Reusable content components in `src/components/templates/` (files starting with `_`) MUST be used and maintained for consistency across integration guides
Applied to files:
src/components/templates/agent-connectors/index.ts
📚 Learning: 2026-02-26T07:20:46.903Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 448
File: src/content/docs/reference/agent-connectors/googlemeet.mdx:1-87
Timestamp: 2026-02-26T07:20:46.903Z
Learning: For auto-generated agent connector documentation pages in src/content/docs/reference/agent-connectors/, the "what's next" signal requirement (next: frontmatter link, <LinkCard>, or concluding paragraph) does not apply. These are reference pages generated by scripts/sync-agent-connectors.js and serve as lookup resources rather than sequential guides.
Applied to files:
src/components/templates/agent-connectors/index.tssrc/components/templates/agent-connectors/_setup-apollo.mdxsrc/components/templates/agent-connectors/_setup-google-looker.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 : Group related imports together at the top of MDX files
Applied to files:
src/components/templates/agent-connectors/index.ts
📚 Learning: 2026-01-13T12:48:11.566Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursor/rules/documentation-guide.mdc:0-0
Timestamp: 2026-01-13T12:48:11.566Z
Learning: Applies to **/*.mdx : Import components at the top of MDX files
Applied to files:
src/components/templates/agent-connectors/index.ts
📚 Learning: 2026-01-13T12:48:11.566Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursor/rules/documentation-guide.mdc:0-0
Timestamp: 2026-01-13T12:48:11.566Z
Learning: Applies to **/*.mdx : Group related imports together in MDX files
Applied to files:
src/components/templates/agent-connectors/index.ts
📚 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 : Import components at the top of MDX files with consistent import paths using `@/` prefix
Applied to files:
src/components/templates/agent-connectors/index.ts
📚 Learning: 2026-03-03T10:47:47.162Z
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} : Proactively address common setup and configuration problems. Keep code examples simple, self-contained, and exportable.
Applied to files:
src/components/templates/agent-connectors/index.ts
📚 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 'collapse={lines}' to hide imports, setup, and boilerplate code in code blocks
Applied to files:
src/components/templates/agent-connectors/index.ts
📚 Learning: 2026-01-13T12:48:11.566Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursor/rules/documentation-guide.mdc:0-0
Timestamp: 2026-01-13T12:48:11.566Z
Learning: Applies to **/*.mdx : Use CardGrid, Card, and LinkCard components for hubs and navigation pages in MDX documentation
Applied to files:
src/components/templates/agent-connectors/index.ts
📚 Learning: 2026-02-25T03:34:46.151Z
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:46.151Z
Learning: Import `Code` from 'astrojs/starlight/components' only when the MDX file actually uses the `<Code>` component. If the file uses only fenced code blocks (```), the Code import is not required.
Applied to files:
src/components/templates/agent-connectors/index.ts
📚 Learning: 2026-01-13T12:48:11.566Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursor/rules/documentation-guide.mdc:0-0
Timestamp: 2026-01-13T12:48:11.566Z
Learning: Applies to **/*.mdx : Use Steps component for sequential instructions in MDX documentation
Applied to files:
src/components/templates/agent-connectors/_setup-apollo.mdx
📚 Learning: 2026-03-03T10:47:47.162Z
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.
Applied to files:
src/components/templates/agent-connectors/_setup-apollo.mdxsrc/content/docs/reference/agent-connectors/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-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: Test MDX documentation locally before committing to catch parsing and Steps component indentation errors
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 : Add context before and after code blocks within Steps components to explain what the code accomplishes
Applied to files:
src/components/templates/agent-connectors/_setup-apollo.mdx
📚 Learning: 2026-02-25T13:33:04.619Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 444
File: src/content/docs/agent-auth/quickstart.mdx:47-47
Timestamp: 2026-02-25T13:33:04.619Z
Learning: In Agent Auth documentation (src/content/docs/agent-auth/**/*.mdx), the Node.js SDK installation must use scalekit-sdk/node2.2.0-beta.1 because Agent Auth features are currently only available in the beta version, not in the latest stable release. Do not flag this as an issue or suggest upgrading to stable versions.
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.mdxsrc/components/templates/agent-connectors/_setup-google-looker.mdx
🔇 Additional comments (2)
src/components/templates/agent-connectors/_setup-apollo.mdx (1)
1-33: LGTM!The setup template follows established patterns correctly: proper Steps component usage, appropriate image imports with
@/assets/docs/prefix, descriptive alt text, and clear step-by-step instructions.src/content/docs/reference/agent-connectors/google_looker.mdx (1)
78-85: LGTM on the layout and branding section.The responsive grid layout, CDN-hosted logo URL, and OAuth badge follow the established pattern for agent connector reference pages.
src/components/templates/agent-connectors/_setup-google-looker.mdx
Outdated
Show resolved
Hide resolved
src/components/templates/agent-connectors/_setup-google-looker.mdx
Outdated
Show resolved
Hide resolved
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/content/docs/reference/agent-connectors/apollo.mdx`:
- Around line 28-71: Extract the inline self-executing heading copy script by
moving the initHeadingCopy function and its DOM listeners into a shared module
named src/scripts/heading-copy.ts (mirroring the pattern used by
src/scripts/examples-filter.ts), export a default initHeadingCopy (or a named
initHeadingCopy function) and any necessary setup for astro:page-load and
DOMContentLoaded; then remove the 40+ line inline script from the MDX files
(e.g., apollo.mdx) and instead include/import the new script as a client-side
script in the Astro layout or the page (ensuring the script runs on client
navigation), keeping the same behavior for clipboard.writeText,
data-copy-initialized attribute, and the visual feedback logic.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: d2f5fd96-577b-405d-9843-13324eb5db4f
⛔ Files ignored due to path filters (21)
src/assets/docs/agent-connectors/airtable/use-own-credentials-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/apollo/use-own-credentials-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/asana/use-own-credentials-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/clickup/use-own-credentials-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/confluence/use-own-credentials-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/dropbox/use-own-credentials-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/github/use-own-credentials-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/gmail/use-own-credentials-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/gong/use-own-credentials-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/google_looker/use-own-credentials-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/googlecalendar/use-own-credentials-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/intercom/use-own-credentials-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/jira/use-own-credentials-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/linear/use-own-credentials-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/monday/use-own-credentials-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/notion/use-own-credentials-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/servicenow/use-own-credentials-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/snowflake/use-own-credentials-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/use-own-credentials-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/zendesk/use-own-credentials-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/zoom/use-own-credentials-redirect-uri.pngis excluded by!**/*.png
📒 Files selected for processing (1)
src/content/docs/reference/agent-connectors/apollo.mdx
📜 Review details
🧰 Additional context used
📓 Path-based instructions (4)
**/*.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/content/docs/reference/agent-connectors/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/content/docs/reference/agent-connectors/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/content/docs/reference/agent-connectors/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/content/docs/reference/agent-connectors/apollo.mdx
src/content/docs/**/*.{md,mdx}
📄 CodeRabbit inference engine (CLAUDE.md)
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.
Proactively address common setup and configuration problems. Keep code examples simple, self-contained, and exportable.
Use imperative for procedures: 'Install', 'Create', 'Run', 'Configure', 'Test'. Front-load the action and start sentences with the verb or key concept.
Explain why when useful. Briefly justify non-obvious steps. Prefer examples over theory; show the common path first and link to details.
Every page MUST include frontmatter with at least:title(≤60 characters),description(≤160 characters), andsidebar.label(1-3 words). Usesidebar.orderonly when navigation ordering matters. Useprev/nextfor sequential guides; useseeAlsofor related guides. EnabletableOfContentsfor longer pages with multiple major sections.
Opening paragraphs (1-3) MUST state what users will accomplish, when/why they need it, and preview the workflow using direct instructional language
The Steps component requires a single continuous ordered list. Steps must start at column 0 with no leading spaces. Continuation content (images, text) must be indented with exactly 3 spaces. Sub-bullet lists use 3 spaces with no blank line before bullets. No blank line immediately after Steps opening tag.
Documentation must be organized into logical sections (FSA, SSO, Directory/SCIM, Connect, M2M, Guides, Reference) with proper sidebar configuration and navigation structure
Files:
src/content/docs/reference/agent-connectors/apollo.mdx
🧠 Learnings (37)
📓 Common learnings
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/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/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: 448
File: scripts/sync-agent-connectors.js:0-0
Timestamp: 2026-02-26T07:18:51.377Z
Learning: In src/content/docs/reference/agent-connectors/**/*.mdx files, sidebar.label frontmatter is not required because the sidebar configuration references the agent-connectors directory for auto-generation. Navigation ordering and grouping are managed centrally in the sidebar configuration file.
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 448
File: src/content/docs/reference/agent-connectors/googlemeet.mdx:1-87
Timestamp: 2026-02-26T07:20:46.903Z
Learning: For auto-generated agent connector documentation pages in src/content/docs/reference/agent-connectors/, the "what's next" signal requirement (next: frontmatter link, <LinkCard>, or concluding paragraph) does not apply. These are reference pages generated by scripts/sync-agent-connectors.js and serve as lookup resources rather than sequential guides.
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: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 463
File: src/content/docs/agent-auth/providers.mdx:35-73
Timestamp: 2026-03-05T11:29:12.786Z
Learning: In `src/content/docs/agent-auth/providers.mdx`, the `<Card>` components use `icon=" "` (a space) intentionally. This is a deliberate UX choice to render consistent colored boxes across all cards, because only some Starlight icon names resolve to actual icons while others do not. Do not flag `icon=" "` as a placeholder issue on this file.
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/guides/integrations/**/*.{md,mdx} : Integration guides in `src/content/docs/guides/integrations/` MUST be kept synchronized with their index pages: `src/content/docs/guides/integrations/index.mdx`, `src/content/docs/guides/integrations/sso-integrations/index.mdx`, `src/content/docs/guides/integrations/social-connections/index.mdx`, and `src/content/docs/guides/integrations/scim-integrations/index.mdx`.
📚 Learning: 2026-02-26T07:22:49.128Z
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:49.128Z
Learning: For MDX files under src/content/docs/reference/agent-connectors, parameter tables are auto-generated from JSON API responses by scripts/sync-agent-connectors.js. Do not manually edit the generated MDX files. Update scripts/sync-agent-connectors.js to output a four-column table with headers Name | Type | Required | Description for all parameter tables, ensuring consistency with the coding guidelines. This pattern should apply to all MDX files in that directory.
Applied to files:
src/content/docs/reference/agent-connectors/apollo.mdx
📚 Learning: 2026-02-26T07:21:32.951Z
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:32.951Z
Learning: For agent-connectors reference MDX files, use H2 headings (##) for tool sections (e.g., googlesheets_create_spreadsheet, googlesheets_get_values) so they appear in the table of contents. This is a deliberate UX choice and should not be flagged as a hierarchy issue.
Applied to files:
src/content/docs/reference/agent-connectors/apollo.mdx
📚 Learning: 2026-02-26T07:20:42.107Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 448
File: src/content/docs/reference/agent-connectors/googlemeet.mdx:1-87
Timestamp: 2026-02-26T07:20:42.107Z
Learning: In src/content/docs/reference/agent-connectors/**, these auto-generated agent connector reference pages (e.g., googlemeet.mdx) are lookup resources. Do not require or enforce the 'what's next' signal (next link, LinkCard, or concluding paragraph) for these pages; treat them as non-sequential references produced by scripts (scripts/sync-agent-connectors.js).
Applied to files:
src/content/docs/reference/agent-connectors/apollo.mdx
📚 Learning: 2026-02-26T07:23:24.179Z
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:24.179Z
Learning: Do not enforce the 160-character description limit for MDX files under src/content/docs/reference/agent-connectors/. These files are auto-generated from API payloads via scripts/sync-agent-connectors.js and may contain longer descriptions sourced from the data.
Applied to files:
src/content/docs/reference/agent-connectors/apollo.mdx
📚 Learning: 2026-03-03T13:35:47.638Z
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:47.638Z
Learning: In Agent Connectors documentation (src/content/docs/reference/agent-connectors/**/*.mdx), only Python SDK examples for Agent Actions/Agent Connectors should be required for now. Do not enforce or require multi-language SDK code examples (Node.js, Python, Go, Java) until the respective SDKs support Agent Actions. Once supported, you can add and require other languages in those docs. This guideline applies to all files under the agent-connectors documentation path.
Applied to files:
src/content/docs/reference/agent-connectors/apollo.mdx
📚 Learning: 2026-02-26T07:18:41.518Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 448
File: scripts/sync-agent-connectors.js:0-0
Timestamp: 2026-02-26T07:18:41.518Z
Learning: For MDX files under src/content/docs/reference/agent-connectors, the sidebar.label frontmatter is not required because navigation is auto-generated from this directory via the central sidebar config. Do not rely on or modify sidebar.label in these files; ensure ordering and grouping are defined in the shared sidebar configuration.
Applied to files:
src/content/docs/reference/agent-connectors/apollo.mdx
📚 Learning: 2026-02-26T07:21:09.133Z
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:09.133Z
Learning: For any agent connector documentation files located in src/content/docs/reference/agent-connectors/, prefer using CDN URLs for connector logos (https://cdn.scalekit.cloud/sk-connect/assets/provider-icons/) instead of inlining or storing images in local assets (e.g., src/assets/docs/). This should override the general guideline to use local assets for this specific docs section. Apply this pattern to all mdx files in that directory; use the CDN-hosted logo URLs in image elements or logo references.
Applied to files:
src/content/docs/reference/agent-connectors/apollo.mdx
📚 Learning: 2026-02-25T13:33:04.619Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 444
File: src/content/docs/agent-auth/quickstart.mdx:47-47
Timestamp: 2026-02-25T13:33:04.619Z
Learning: In Agent Auth documentation (src/content/docs/agent-auth/**/*.mdx), the Node.js SDK installation must use scalekit-sdk/node2.2.0-beta.1 because Agent Auth features are currently only available in the beta version, not in the latest stable release. Do not flag this as an issue or suggest upgrading to stable versions.
Applied to files:
src/content/docs/reference/agent-connectors/apollo.mdx
📚 Learning: 2026-03-03T10:47:47.162Z
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.
Applied to files:
src/content/docs/reference/agent-connectors/apollo.mdx
📚 Learning: 2026-03-09T15:06:42.815Z
Learnt from: hrishikesh-p
Repo: scalekit-inc/developer-docs PR: 473
File: src/content/docs/agent-auth/tools/execute.mdx:34-76
Timestamp: 2026-03-09T15:06:42.815Z
Learning: In src/content/docs/agent-auth/tools/**/*.mdx (Agent Auth tool execution docs, e.g., execute.mdx, authorize.mdx), only Python and Node.js SDK support is currently available for Agent Auth tool execution. Do not require or enforce Go and Java tabs in Tabs syncKey="tech-stack" blocks for these files until the Go and Java SDKs support Agent Auth features. Add Go and Java TabItems once those SDKs are ready.
Applied to files:
src/content/docs/reference/agent-connectors/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/content/docs/reference/agent-connectors/apollo.mdx
📚 Learning: 2026-01-13T12:48:19.565Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursor/rules/expressive-code.mdc:0-0
Timestamp: 2026-01-13T12:48:19.565Z
Learning: Applies to **/*.mdx : Import `{ Code }` from `astrojs/starlight/components` once per `.mdx` file, placing the import below frontmatter
Applied to files:
src/content/docs/reference/agent-connectors/apollo.mdx
📚 Learning: 2026-03-05T11:29:08.125Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 463
File: src/content/docs/agent-auth/providers.mdx:35-73
Timestamp: 2026-03-05T11:29:08.125Z
Learning: In src/content/docs/agent-auth/providers.mdx, the Card components intentionally use icon=" " (a space) to render consistent colored boxes since some Starlight icon names resolve to icons and others do not. Do not flag icon=" " as a placeholder issue for this file; treat this as a deliberate UX choice specific to this MDX page and avoid raising a placeholder-icon warning here.
Applied to files:
src/content/docs/reference/agent-connectors/apollo.mdx
📚 Learning: 2026-01-13T12:48:19.565Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursor/rules/expressive-code.mdc:0-0
Timestamp: 2026-01-13T12:48:19.565Z
Learning: Applies to **/*.{md,mdx} : Use Expressive Code consistently across all documentation pages, preferring Starlight's `<Code>` component for rich features (titles, markers, accurate syntax highlighting) and dynamic snippets over fenced code blocks
Applied to files:
src/content/docs/reference/agent-connectors/apollo.mdx
📚 Learning: 2026-03-03T10:47:47.162Z
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/components/templates/_*.{tsx,jsx,astro} : Reusable content components in `src/components/templates/` (files starting with `_`) MUST be used and maintained for consistency across integration guides
Applied to files:
src/content/docs/reference/agent-connectors/apollo.mdx
📚 Learning: 2026-01-13T12:48:19.565Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursor/rules/expressive-code.mdc:0-0
Timestamp: 2026-01-13T12:48:19.565Z
Learning: Applies to **/*.mdx : Prefer `<Code>` component when code snippets need any of: filename/title, text markers, programmatic/dynamic content, or consistent theming across tabs
Applied to files:
src/content/docs/reference/agent-connectors/apollo.mdx
📚 Learning: 2026-01-13T12:48:11.566Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursor/rules/documentation-guide.mdc:0-0
Timestamp: 2026-01-13T12:48:11.566Z
Learning: Applies to **/*.mdx : Use CardGrid, Card, and LinkCard components for hubs and navigation pages in MDX documentation
Applied to files:
src/content/docs/reference/agent-connectors/apollo.mdx
📚 Learning: 2026-01-13T12:48:11.566Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursor/rules/documentation-guide.mdc:0-0
Timestamp: 2026-01-13T12:48:11.566Z
Learning: Applies to **/*.mdx : Import components at the top of MDX files
Applied to files:
src/content/docs/reference/agent-connectors/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 'collapse={lines}' to hide imports, setup, and boilerplate code in code blocks
Applied to files:
src/content/docs/reference/agent-connectors/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 : Import components at the top of MDX files with consistent import paths using `@/` prefix
Applied to files:
src/content/docs/reference/agent-connectors/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 astro.config.mjs : Expressive Code collapsible sections plugin must be enabled in `astro.config.mjs`
Applied to files:
src/content/docs/reference/agent-connectors/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 : Group related imports together at the top of MDX files
Applied to files:
src/content/docs/reference/agent-connectors/apollo.mdx
📚 Learning: 2026-01-13T12:48:11.566Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursor/rules/documentation-guide.mdc:0-0
Timestamp: 2026-01-13T12:48:11.566Z
Learning: Applies to **/*.mdx : Group related imports together in MDX files
Applied to files:
src/content/docs/reference/agent-connectors/apollo.mdx
📚 Learning: 2026-03-03T10:47:47.162Z
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 **/*.{md,mdx} : Use subheadings to clarify purpose or scope, not marketing. Avoid gerunds in headings when an imperative works; prefer 'Configure proxies' over 'Configuring proxies'.
Applied to files:
src/content/docs/reference/agent-connectors/apollo.mdx
📚 Learning: 2026-03-03T10:47:47.162Z
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 **/*.{md,mdx} : Headings should describe outcomes, not categories. Example: 'Run a script' (good) not 'Scripts' (bad).
Applied to files:
src/content/docs/reference/agent-connectors/apollo.mdx
📚 Learning: 2026-01-13T12:48:11.566Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursor/rules/documentation-guide.mdc:0-0
Timestamp: 2026-01-13T12:48:11.566Z
Learning: Applies to **/*.{md,mdx} : Maintain proper heading hierarchy and list semantics in documentation for accessibility
Applied to files:
src/content/docs/reference/agent-connectors/apollo.mdx
📚 Learning: 2026-03-03T10:47:47.162Z
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 **/*.{md,mdx} : Use descriptive link text like 'See permission flags' not 'click here'. Prefer relative links for internal pages; include anchors for sections. Reference APIs consistently with backticks for code.
Applied to files:
src/content/docs/reference/agent-connectors/apollo.mdx
📚 Learning: 2026-01-13T12:48:11.566Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursor/rules/documentation-guide.mdc:0-0
Timestamp: 2026-01-13T12:48:11.566Z
Learning: Applies to **/*.{md,mdx} : Follow a logical heading hierarchy (H2, H3, H4) and keep sections focused and scannable
Applied to files:
src/content/docs/reference/agent-connectors/apollo.mdx
📚 Learning: 2026-01-13T12:47:52.148Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursor/rules/deno-docs-style.mdc:0-0
Timestamp: 2026-01-13T12:47:52.148Z
Learning: Applies to **/*.{md,mdx} : Use outcome-focused headings that describe results, not categories (e.g., 'Run a script' not 'Scripts')
Applied to files:
src/content/docs/reference/agent-connectors/apollo.mdx
📚 Learning: 2026-01-30T18:18:50.883Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 415
File: src/content/docs/authenticate/fsa/multiapp/manage-apps.mdx:31-49
Timestamp: 2026-01-30T18:18:50.883Z
Learning: In all Scalekit documentation files (MDX), treat the terms 'Applications', 'Single Page Application (SPA)', 'Native Application', and 'Web Application' as proper nouns and preserve their capitalization in headings and body text. Ensure these terms remain capitalized even when used in sentence case or within prose.
Applied to files:
src/content/docs/reference/agent-connectors/apollo.mdx
📚 Learning: 2026-02-04T12:47:16.544Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 412
File: src/content/docs/dev-kit/tools/scalekit-dryrun.mdx:1-23
Timestamp: 2026-02-04T12:47:16.544Z
Learning: In scalekit-inc/developer-docs, the MDX frontmatter field order is required only when the sidebar configuration points to a directory (for auto-generation). If the sidebar.config.ts references a specific file path, the order field is not required. Apply this check to all MDX files under src/content/docs: if a file contributes to an auto-generated sidebar (directory path), ensure order is present; if it’s linked to a concrete file, order can be omitted. Use sidebar.config.ts to determine whether a given MDX file falls under directory-based vs file-specific sidebar references.
Applied to files:
src/content/docs/reference/agent-connectors/apollo.mdx
📚 Learning: 2026-02-25T08:57:12.201Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 444
File: src/content/docs/agent-auth/quickstart.mdx:2-10
Timestamp: 2026-02-25T08:57:12.201Z
Learning: In Scalekit developer-docs (Astro Starlight), do not auto-suggest adding tableOfContents in frontmatter unless the user explicitly overrides the default behavior. The default enables tableOfContents with minHeadingLevel 2 and maxHeadingLevel 3. Only set tableOfContents when you want to customize heading levels or disable it entirely; otherwise omit it for other docs.
Applied to files:
src/content/docs/reference/agent-connectors/apollo.mdx
📚 Learning: 2026-02-25T13:04:27.491Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 444
File: src/content/docs/agent-auth/start-agent-auth-coding-agents.mdx:9-17
Timestamp: 2026-02-25T13:04:27.491Z
Learning: Allow page-level CSS overrides in MDX frontmatter (head: style) for readability and engagement, even if it customizes typography beyond defaults. This applies to per-page UX decisions, including heading sizes and style tweaks, but keep overrides purposeful, accessible, and within the repository's design guidelines. Use these overrides sparingly and document the rationale for maintainability.
Applied to files:
src/content/docs/reference/agent-connectors/apollo.mdx
📚 Learning: 2026-03-09T07:27:56.794Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 469
File: src/content/docs/guides/integrations/scim-integrations/azure-scim.mdx:95-107
Timestamp: 2026-03-09T07:27:56.794Z
Learning: Do not enforce the 3-space indentation rule for Steps component content as a hard style rule in MDX files under src/content/docs/**/*.mdx. Only flag/rectify it if it causes visible rendering problems in the UI. Otherwise, allow current formatting; apply this rule only when rendering issues are observed and document any fixes.
Applied to files:
src/content/docs/reference/agent-connectors/apollo.mdx
📚 Learning: 2026-03-09T07:32:38.426Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 467
File: src/content/docs/sso/guides/sso-user-attributes.mdx:108-148
Timestamp: 2026-03-09T07:32:38.426Z
Learning: In MDX code samples under src/content/docs (and similar conceptual snippets in scalekit-inc/developer-docs), when an example's sole purpose is to show how to access a specific value (e.g., reading JWT claims after token validation), omit error/non-happy-path handling to keep the snippet focused. Do not flag the absence of error paths in narrowly scoped conceptual snippets.
Applied to files:
src/content/docs/reference/agent-connectors/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/content/docs/reference/agent-connectors/apollo.mdx
🪛 LanguageTool
src/content/docs/reference/agent-connectors/apollo.mdx
[uncategorized] ~183-~183: The name of this social business platform is spelled with a capital “I”.
Context: ...f the account (e.g., example.com) | | linkedin_url | string | No | LinkedIn profile U...
(LINKEDIN)
[uncategorized] ~197-~197: The name of this social business platform is spelled with a capital “I”.
Context: ...| No | Email address of the contact | | linkedin_url | string | No | LinkedIn profile U...
(LINKEDIN)
[uncategorized] ~222-~222: The name of this social business platform is spelled with a capital “I”.
Context: ...ring | No | Last name of the person | | linkedin_url | string | No | LinkedIn profile U...
(LINKEDIN)
[uncategorized] ~297-~297: The name of this social business platform is spelled with a capital “I”.
Context: ...| string | No | Updated last name | |linkedin_url` | string | No | Updated LinkedIn p...
(LINKEDIN)
🔇 Additional comments (5)
src/content/docs/reference/agent-connectors/apollo.mdx (5)
74-76: Remove unused imports.
Code,Accordion, andAccordionItemare imported but never used in this file.♻️ Proposed fix
-import { Card, CardGrid, Tabs, TabItem, Badge, Steps, Aside, Code } from '@astrojs/starlight/components' -import { Accordion, AccordionItem } from 'accessible-astro-components' +import { Card, CardGrid, Tabs, TabItem, Badge, Steps, Aside } from '@astrojs/starlight/components' import { SetupApolloSection } from '@components/templates'
173-175: Redundant "Tool list" heading.The
## Tool listheading on line 173 immediately precedes the first tool heading## apollo_create_accounton line 175. Since each tool already has its own H2 heading that appears in the table of contents, this extra heading adds no value and creates an empty section.♻️ Proposed fix — remove or convert to intro text
-## Tool list - ## `apollo_create_account`Or replace with a brief introductory paragraph:
-## Tool list +The following tools are available for the Apollo connector: ## `apollo_create_account`
78-91: LGTM!The layout structure is well-organized: grid layout with description and logo using the CDN URL (per learnings for agent-connector docs), authentication badge, and the setup section component.
135-170: LGTM!The Python code example correctly uses
scalekit_clientvariable naming per SDK guidelines. The commented-out Node.js tab is acceptable since only Python SDK is currently required for Agent Connectors documentation. Based on learnings: "only Python SDK examples for Agent Actions/Agent Connectors should be required for now."
175-300: LGTM!Tool sections correctly use H2 headings for table-of-contents visibility (per learnings). Parameter tables follow the expected four-column format (Name | Type | Required | Description). The
linkedin_urlidentifiers are correctly lowercase in backticks as code identifiers — the static analysis hints are false positives.
Pranesh-Raghu
changed the title
Summary by CodeRabbit