Enrich apollo docs#481
Conversation
…o match portal UI
Pranesh-Raghu
requested review from
amitash1912,
ravibits and
saif-at-scalekit
as code owners
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (1)
📜 Recent review details🧰 Additional context used📓 Path-based instructions (4)**/*.mdx📄 CodeRabbit inference engine (.cursorrules)
Files:
⚙️ CodeRabbit configuration file
Files:
**/*.{yml,yaml,md,mdx}📄 CodeRabbit inference engine (.cursor/rules/browsecentral-labels.mdc)
Files:
**/*.{md,mdx}📄 CodeRabbit inference engine (.cursor/rules/deno-docs-style.mdc)
Files:
src/content/docs/**/*.{md,mdx}📄 CodeRabbit inference engine (CLAUDE.md)
Files:
🧠 Learnings (35)📓 Common learnings📚 Learning: 2026-03-03T13:35:47.638ZApplied to files:
📚 Learning: 2026-02-25T13:33:04.619ZApplied to files:
📚 Learning: 2026-03-09T15:06:49.617ZApplied to files:
📚 Learning: 2026-03-03T10:47:47.162ZApplied to files:
📚 Learning: 2026-02-26T07:22:49.128ZApplied to files:
📚 Learning: 2026-02-26T07:21:32.951ZApplied to files:
📚 Learning: 2026-02-02T05:55:51.251ZApplied to files:
📚 Learning: 2026-02-26T07:23:24.179ZApplied to files:
📚 Learning: 2026-01-13T12:46:55.260ZApplied to files:
📚 Learning: 2026-01-13T12:48:11.566ZApplied to files:
📚 Learning: 2026-03-10T10:37:49.873ZApplied to files:
📚 Learning: 2026-02-26T07:21:09.133ZApplied to files:
📚 Learning: 2026-03-10T10:38:35.371ZApplied to files:
📚 Learning: 2026-02-26T07:20:42.107ZApplied to files:
📚 Learning: 2026-03-10T10:38:36.402ZApplied to files:
📚 Learning: 2026-01-13T12:47:52.148ZApplied to files:
📚 Learning: 2026-01-13T12:46:55.260ZApplied to files:
📚 Learning: 2026-01-13T12:48:19.565ZApplied to files:
📚 Learning: 2026-03-03T10:47:47.162ZApplied to files:
📚 Learning: 2026-03-03T10:47:47.162ZApplied to files:
📚 Learning: 2026-01-13T12:48:19.565ZApplied to files:
📚 Learning: 2026-01-13T12:48:11.566ZApplied to files:
📚 Learning: 2026-03-03T10:47:47.162ZApplied to files:
📚 Learning: 2026-01-13T12:48:19.565ZApplied to files:
📚 Learning: 2026-01-30T18:18:50.883ZApplied to files:
📚 Learning: 2026-02-04T12:47:16.544ZApplied to files:
📚 Learning: 2026-02-25T08:57:12.201ZApplied to files:
📚 Learning: 2026-02-25T13:04:27.491ZApplied to files:
📚 Learning: 2026-03-05T11:29:08.125ZApplied to files:
📚 Learning: 2026-03-09T07:27:56.794ZApplied to files:
📚 Learning: 2026-03-09T07:32:38.426ZApplied to files:
📚 Learning: 2026-02-25T03:34:41.147ZApplied to files:
📚 Learning: 2026-02-25T18:41:00.639ZApplied to files:
📚 Learning: 2026-02-26T07:18:41.518ZApplied to files:
🔇 Additional comments (3)
WalkthroughRewrote and reorganized Apollo connector documentation: added an Aside import and warnings, reordered OAuth setup steps, clarified redirect URI and credential handling, and updated Node.js/Python examples to use the new Scalekit client property patterns (scalekit.connectedAccounts / scalekit.actions). 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}
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
src/content/docs/reference/agent-connectors/apollo.mdx (2)
122-151: 🧹 Nitpick | 🔵 TrivialAdd
titleattribute, error handling, and security comments to the code example.Per coding guidelines, code blocks must have a
title=attribute showing the file path, include both success and error paths, and explain security implications for credential handling.Proposed improvements for Node.js example
- ```typescript + ```typescript title="apollo-connector.ts" import Scalekit from '@scalekit-sdk/node'; import 'dotenv/config'; const connectionName = 'apollo'; // connection name from Scalekit dashboard const identifier = 'user_123'; // your unique user identifier - // Get credentials from app.scalekit.com → Developers → API Credentials + // SECURITY: Load credentials from environment variables, never hard-code secrets const scalekit = new Scalekit({ clientId: process.env.SCALEKIT_CLIENT_ID, clientSecret: process.env.SCALEKIT_CLIENT_SECRET, envUrl: process.env.SCALEKIT_ENV_URL, }); - // Get authorization link and send it to your user - const { link } = await scalekit.connectedAccounts.getMagicLinkForConnectedAccount({ - connector: connectionName, - identifier, - }); - console.log('Authorize Apollo:', link); + try { + // Get authorization link and send it to your user + const { link } = await scalekit.connectedAccounts.getMagicLinkForConnectedAccount({ + connector: connectionName, + identifier, + }); + console.log('Authorize Apollo:', link); - // After the user authorizes, make API calls via Scalekit proxy - const result = await scalekit.actions.request({ - connectionName, - identifier, - path: '/v1/contacts/search', - method: 'POST', - }); - console.log(result); + // After the user authorizes, make API calls via Scalekit proxy + const result = await scalekit.actions.request({ + connectionName, + identifier, + path: '/v1/contacts/search', + method: 'POST', + }); + console.log(result); + } catch (error) { + console.error('Apollo API error:', error.message); + }🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/content/docs/reference/agent-connectors/apollo.mdx` around lines 122 - 151, Add a title attribute to the TypeScript code fence (e.g., title="apollo-connector.ts"), add a brief SECURITY comment above the Scalekit constructor explaining to load credentials from environment variables and never hard-code secrets, and wrap the async calls to Scalekit.connectedAccounts.getMagicLinkForConnectedAccount and Scalekit.actions.request in a try/catch that logs errors (reference methods connectedAccounts.getMagicLinkForConnectedAccount and actions.request on the Scalekit instance) so both success and error paths are shown.
154-184: 🧹 Nitpick | 🔵 TrivialAdd
titleattribute, error handling, and security comments to the Python example.Same improvements needed as the Node.js example.
Proposed improvements for Python example
- ```python + ```python title="apollo_connector.py" import scalekit.client, os from dotenv import load_dotenv load_dotenv() connection_name = "apollo" # connection name from Scalekit dashboard identifier = "user_123" # your unique user identifier - # Get credentials from app.scalekit.com → Developers → API Credentials + # SECURITY: Load credentials from environment variables, never hard-code secrets scalekit_client = scalekit.client.ScalekitClient( client_id=os.getenv("SCALEKIT_CLIENT_ID"), client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"), env_url=os.getenv("SCALEKIT_ENV_URL"), ) - # Get authorization link and send it to your user - link_response = scalekit_client.actions.get_authorization_link( - connection_name=connection_name, - identifier=identifier - ) - print("Authorize Apollo:", link_response.link) + try: + # Get authorization link and send it to your user + link_response = scalekit_client.actions.get_authorization_link( + connection_name=connection_name, + identifier=identifier + ) + print("Authorize Apollo:", link_response.link) - # After the user authorizes, make API calls via Scalekit proxy - result = scalekit_client.actions.request( - connection_name=connection_name, - identifier=identifier, - path="/v1/contacts/search", - method="POST" - ) - print(result) + # After the user authorizes, make API calls via Scalekit proxy + result = scalekit_client.actions.request( + connection_name=connection_name, + identifier=identifier, + path="/v1/contacts/search", + method="POST" + ) + print(result) + except Exception as e: + print(f"Apollo API error: {e}")🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/content/docs/reference/agent-connectors/apollo.mdx` around lines 154 - 184, Add a title attribute to the Python code fence (e.g., title="apollo_connector.py"), add a SECURITY comment about loading credentials from environment variables (do not hard-code secrets) near the scalekit.client.ScalekitClient instantiation, and wrap the calls to scalekit_client.actions.get_authorization_link and scalekit_client.actions.request in a try/except block that catches Exception and logs/prints a concise error message (e.g., "Apollo API error: {e}"); reference the scalekit.client.ScalekitClient instantiation, scalekit_client.actions.get_authorization_link, and scalekit_client.actions.request to locate the changes.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@src/components/templates/agent-connectors/_setup-apollo.mdx`:
- Line 1: Remove the unused Aside import from the import statement so only used
components are imported; edit the line importing Steps and Aside (the import
that currently reads "import { Steps, Aside } from
'@astrojs/starlight/components'") and drop Aside so it becomes just importing
Steps.
---
Outside diff comments:
In `@src/content/docs/reference/agent-connectors/apollo.mdx`:
- Around line 122-151: Add a title attribute to the TypeScript code fence (e.g.,
title="apollo-connector.ts"), add a brief SECURITY comment above the Scalekit
constructor explaining to load credentials from environment variables and never
hard-code secrets, and wrap the async calls to
Scalekit.connectedAccounts.getMagicLinkForConnectedAccount and
Scalekit.actions.request in a try/catch that logs errors (reference methods
connectedAccounts.getMagicLinkForConnectedAccount and actions.request on the
Scalekit instance) so both success and error paths are shown.
- Around line 154-184: Add a title attribute to the Python code fence (e.g.,
title="apollo_connector.py"), add a SECURITY comment about loading credentials
from environment variables (do not hard-code secrets) near the
scalekit.client.ScalekitClient instantiation, and wrap the calls to
scalekit_client.actions.get_authorization_link and
scalekit_client.actions.request in a try/except block that catches Exception and
logs/prints a concise error message (e.g., "Apollo API error: {e}"); reference
the scalekit.client.ScalekitClient instantiation,
scalekit_client.actions.get_authorization_link, and
scalekit_client.actions.request to locate the changes.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: 8dc71fe2-8baf-4b7d-b432-0b92fb08c4b0
⛔ Files ignored due to path filters (2)
src/assets/docs/agent-connectors/apollo/client-credentials.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/apollo/create-oauth-app.pngis excluded by!**/*.png
📒 Files selected for processing (2)
src/components/templates/agent-connectors/_setup-apollo.mdxsrc/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/components/templates/agent-connectors/_setup-apollo.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/components/templates/agent-connectors/_setup-apollo.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/components/templates/agent-connectors/_setup-apollo.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/components/templates/agent-connectors/_setup-apollo.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/apollo.mdx
🧠 Learnings (30)
📓 Common learnings
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 424
File: public/api/scalekit.scalar.json:3451-3457
Timestamp: 2026-02-10T05:32:59.967Z
Learning: In scalekit-inc/developer-docs, the file public/api/scalekit.scalar.json is a generated OpenAPI artifact; reviewers should avoid direct edits. For inconsistencies (e.g., the /api/v1/permissions "type" query param description vs. enum), handle short-term via release/PR notes and track long-term fixes in the generator or source templates rather than modifying the generated JSON.
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 exact SDK variable names: Node.js: `scalekit`, Python: `scalekit_client`, Go: `scalekitClient`, Java: `scalekitClient` in all documentation and code examples
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 415
File: src/content/docs/authenticate/fsa/multiapp/native-app.mdx:72-179
Timestamp: 2026-02-02T05:55:51.251Z
Learning: In the `src/content/docs/authenticate/fsa/multiapp/` directory, the multi-app authentication documentation (native-app.mdx, single-page-app.mdx, web-app.mdx, overview.mdx) currently uses conceptual shell/curl examples instead of multi-language SDK code examples because the Scalekit SDKs have not yet been built/updated for multi-app functionality. Once the SDKs are ready, these files should be updated to include all 4 languages (Node.js, Python, Go, Java) using `<Tabs syncKey="tech-stack">`.
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.
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursorrules:0-0
Timestamp: 2026-01-13T12:46:55.260Z
Learning: Applies to **/*.mdx : Use present tense for descriptions: 'Scalekit handles the complex authentication flow', 'The SDK provides methods to refresh tokens'
📚 Learning: 2026-03-10T10:37:47.033Z
Learnt from: Pranesh-Raghu
Repo: scalekit-inc/developer-docs PR: 475
File: src/components/templates/agent-connectors/_setup-asana.mdx:15-15
Timestamp: 2026-03-10T10:37:47.033Z
Learning: In src/components/templates/agent-connectors/**/*.mdx, it is acceptable to reuse a single shared redirect URI screenshot (use-own-credentials-redirect-uri.png) across multiple steps within the same connector file, even if different UIs are shown. Do not flag this reuse as an issue; ensure this behavior is intentional and documented for reviewers.
Applied to files:
src/components/templates/agent-connectors/_setup-apollo.mdx
📚 Learning: 2026-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 Aside component for notes, warnings, and tips in MDX documentation
Applied to files:
src/components/templates/agent-connectors/_setup-apollo.mdx
📚 Learning: 2026-03-10T10:38:27.783Z
Learnt from: Pranesh-Raghu
Repo: scalekit-inc/developer-docs PR: 475
File: src/components/templates/agent-connectors/_setup-confluence.mdx:16-16
Timestamp: 2026-03-10T10:38:27.783Z
Learning: In all MDX templates under src/components/templates/agent-connectors, the pattern uses empty alt text (e.g., ![]()) for redirect URI screenshots like use-own-credentials-redirect-uri.png. This is intentional; reviews should not flag missing alt text for these images in this directory.
Applied to files:
src/components/templates/agent-connectors/_setup-apollo.mdx
📚 Learning: 2026-03-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/_setup-apollo.mdx
📚 Learning: 2026-03-10T10:38:30.012Z
Learnt from: Pranesh-Raghu
Repo: scalekit-inc/developer-docs PR: 475
File: src/components/templates/agent-connectors/_setup-clickup.mdx:17-17
Timestamp: 2026-03-10T10:38:30.012Z
Learning: In the repository's agent-connectors setup template files (src/components/templates/agent-connectors/_setup-*.mdx), the pattern for redirect URI screenshot images is to use empty alt text (![]()). Do not flag missing alt text for these specific Markdown image syntaxes in the agent connector setup template files. This guidance applies only to files matching this setup-*.mdx naming pattern; other templates should continue to enforce standard alt text practices.
Applied to files:
src/components/templates/agent-connectors/_setup-apollo.mdx
📚 Learning: 2026-01-13T12:46:55.260Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursorrules:0-0
Timestamp: 2026-01-13T12:46:55.260Z
Learning: Applies to **/*.mdx : Use Aside components for important notes, tips, and warnings in MDX documentation
Applied to files:
src/components/templates/agent-connectors/_setup-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/components/templates/agent-connectors/_setup-apollo.mdx
📚 Learning: 2026-02-25T03:34:41.147Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 444
File: src/content/docs/agent-auth/start-agent-auth-coding-agents.mdx:31-31
Timestamp: 2026-02-25T03:34:41.147Z
Learning: In MDX files, import { Code } from 'astrojs/starlight/components' only if the MDX content actually uses the <Code> component. If the file uses only fenced code blocks (```), the import is not required. Apply this guideline to all MDX files (e.g., src/content/docs/**/*.mdx) to avoid unnecessary imports and reduce bundle size.
Applied to files:
src/components/templates/agent-connectors/_setup-apollo.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-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.mdxsrc/content/docs/reference/agent-connectors/apollo.mdx
📚 Learning: 2026-03-10T12:26:38.439Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 476
File: src/content/docs/guides/integrations/sso-integrations/okta-oidc.mdx:84-99
Timestamp: 2026-03-10T12:26:38.439Z
Learning: In scalekit-inc/developer-docs, integration guide pages under `src/content/docs/guides/integrations/` (including SSO integrations, SCIM integrations, and social connections) do not require a "what's next" signal, "Next steps" section, or concluding navigation links. Do not flag the absence of these elements on integration guide pages.
Applied to files:
src/components/templates/agent-connectors/_setup-apollo.mdx
📚 Learning: 2026-02-02T05:55:51.251Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 415
File: src/content/docs/authenticate/fsa/multiapp/native-app.mdx:72-179
Timestamp: 2026-02-02T05:55:51.251Z
Learning: In the `src/content/docs/authenticate/fsa/multiapp/` directory, the multi-app authentication documentation (native-app.mdx, single-page-app.mdx, web-app.mdx, overview.mdx) currently uses conceptual shell/curl examples instead of multi-language SDK code examples because the Scalekit SDKs have not yet been built/updated for multi-app functionality. Once the SDKs are ready, these files should be updated to include all 4 languages (Node.js, Python, Go, Java) using `<Tabs syncKey="tech-stack">`.
Applied to files:
src/components/templates/agent-connectors/_setup-apollo.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/components/templates/agent-connectors/_setup-apollo.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/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: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-02-10T05:32:59.967Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 424
File: public/api/scalekit.scalar.json:3451-3457
Timestamp: 2026-02-10T05:32:59.967Z
Learning: In scalekit-inc/developer-docs, the file public/api/scalekit.scalar.json is a generated OpenAPI artifact; reviewers should avoid direct edits. For inconsistencies (e.g., the /api/v1/permissions "type" query param description vs. enum), handle short-term via release/PR notes and track long-term fixes in the generator or source templates rather than modifying the generated JSON.
Applied to files:
src/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 exact SDK variable names: Node.js: `scalekit`, Python: `scalekit_client`, Go: `scalekitClient`, Java: `scalekitClient` in all documentation and code examples
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-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-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-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: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: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-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
🔇 Additional comments (5)
src/components/templates/agent-connectors/_setup-apollo.mdx (1)
5-36: LGTM!The Steps component is well-structured with clear, action-oriented instructions. The OAuth registration flow is logically organized, and the credential handling guidance is appropriate.
src/content/docs/reference/agent-connectors/apollo.mdx (4)
93-115: LGTM!The Required scopes section is well-structured with a clear scope-to-tool mapping table and appropriate caution about paid plan restrictions. The link to Apollo OAuth documentation provides helpful external reference.
230-233: LGTM!The Aside cautions for paid plan restrictions are appropriately placed near the relevant tools (
apollo_enrich_contact,apollo_search_accounts,apollo_search_contacts), providing clear visibility of plan limitations.Also applies to: 274-276, 292-294
169-174: No action needed. The Python and Node.js methods are the correct, intentional equivalents in each SDK.actions.get_authorization_link(Python) andconnectedAccounts.getMagicLinkForConnectedAccount(Node.js) are functionally identical and follow standard naming conventions for their respective languages. This pattern is used consistently across all 40+ agent-connector documentation files.> Likely an incorrect or invalid review comment.
136-141: API verified:getMagicLinkForConnectedAccountexists on theconnectedAccountsnamespace and accepts the correct parameters.The method is consistently used across 50+ documentation pages in the codebase, confirming it's a standard Scalekit API. The Node.js code at lines 136–141 correctly uses
scalekit.connectedAccounts.getMagicLinkForConnectedAccount()withconnectorandidentifierparameters, matching the established pattern.
… table and full UI steps
There was a problem hiding this comment.
Actionable comments posted: 2
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
src/content/docs/reference/agent-connectors/apollo.mdx (1)
100-160:⚠️ Potential issue | 🟠 MajorMove these Apollo doc changes into the generator.
This page lives under
src/content/docs/reference/agent-connectors/, so patching the MDX directly makes the new SDK examples and paid-plan warnings vulnerable to the next sync. Please move these Apollo-specific changes intoscripts/sync-agent-connectors.jsor its source data instead of editing the generated page.Based on learnings, "For MDX files under
src/content/docs/reference/agent-connectors, parameter tables are auto-generated from JSON API responses byscripts/sync-agent-connectors.js. Do not manually edit the generated MDX files."Also applies to: 207-286
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/content/docs/reference/agent-connectors/apollo.mdx` around lines 100 - 160, The apollo.mdx changes were made directly to a generated file; revert those edits and instead add the Apollo SDK examples and paid-plan warning into the generator/data so they survive syncs: update scripts/sync-agent-connectors.js (or the JSON/YAML source that script consumes) to inject the new JavaScript and Python example snippets and the paid-plan notice for the "apollo" connector when the generator builds docs (look for the generator function like generateConnectorMd/buildConnectorDoc or the data key for connector "apollo" and add the example strings and warning text there), then re-run the sync to regenerate src/content/docs/reference/agent-connectors/apollo.mdx.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@src/components/templates/agent-connectors/_setup-apollo.mdx`:
- Line 19: Update the step reference text "Keep this tab open — you'll return to
it in step 3." in the _setup-apollo.mdx template to correctly point to step 4;
locate the exact string in the file and change "step 3" to "step 4" so the
instruction matches the actual walkthrough flow.
In `@src/content/docs/reference/agent-connectors/apollo.mdx`:
- Around line 103-117: The code uses connectionName and passes it as the
connector parameter to
scalekit.connectedAccounts.getMagicLinkForConnectedAccount(), which is
misleading; change the variable name to connectorSlug (or update the comment)
and clarify that this value must be the provider slug/identifier from the
Scalekit dashboard (not a custom user-defined connection name) so readers
understand that connector is a fixed provider identifier.
---
Outside diff comments:
In `@src/content/docs/reference/agent-connectors/apollo.mdx`:
- Around line 100-160: The apollo.mdx changes were made directly to a generated
file; revert those edits and instead add the Apollo SDK examples and paid-plan
warning into the generator/data so they survive syncs: update
scripts/sync-agent-connectors.js (or the JSON/YAML source that script consumes)
to inject the new JavaScript and Python example snippets and the paid-plan
notice for the "apollo" connector when the generator builds docs (look for the
generator function like generateConnectorMd/buildConnectorDoc or the data key
for connector "apollo" and add the example strings and warning text there), then
re-run the sync to regenerate
src/content/docs/reference/agent-connectors/apollo.mdx.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: 72f69f8b-83db-4458-9684-ab16f9650e2b
📒 Files selected for processing (2)
src/components/templates/agent-connectors/_setup-apollo.mdxsrc/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.mdxsrc/components/templates/agent-connectors/_setup-apollo.mdx
⚙️ CodeRabbit configuration file
**/*.mdx: You are reviewing Scalekit developer documentation written in MDX
(Astro + Starlight framework). Apply ALL of the following checks:Frontmatter
titleMUST be ≤ 60 characters and clearly state what the page does.descriptionMUST be ≤ 160 characters, action-oriented, unique per page.sidebar.labelMUST be present and ≤ 30 characters.sidebar.orderMUST be set on every page that lives inside a section
with siblings, to enforce the journey order in sidebar.config.ts.- Flag any missing
prev/nextlinks on pages that are clearly
part of a sequential flow (e.g., quickstart → implement-login →
complete-login → manage-session → logout).Voice & Style (CLAUDE.md standards)
- Voice: confident, direct, collaborative, instructional.
- Person: second person only ("you", "your application"). Reject "we",
"our", "the developer", "the user".- Tense: present tense for descriptions; imperative mood for instructions.
- Flag weasel words: "simply", "just", "easy", "straightforward",
"obviously", "of course", "note that".- Flag passive voice constructions where active voice is clearer.
- Headings must be sentence case, not Title Case (except proper nouns).
- No heading should end with a colon or period.
Content structure
- How-to guides MUST contain numbered
<Steps>(Starlight component).- Concept pages MUST NOT contain numbered steps — concepts explain, not instruct.
- API reference pages MUST list parameters in a table with Name / Type /
Required / Description columns.- Every page MUST end with a clear "what's next" signal — either a
next:frontmatter link, a<LinkCard>, or an explicit paragraph
pointing the reader forward in the sidebar journey.Code examples
- ALL code examples that show SDK usage MUST include all four language
tabs: Node.js, Python, Go, Java — using<Tabs syncKey="tech-stack">.- SDK variable names are STRICTLY:
scalekit(Node.js),
scalekit_client(Python),scalekitClient(Go), ...
Files:
src/content/docs/reference/agent-connectors/apollo.mdxsrc/components/templates/agent-connectors/_setup-apollo.mdx
**/*.{yml,yaml,md,mdx}
📄 CodeRabbit inference engine (.cursor/rules/browsecentral-labels.mdc)
**/*.{yml,yaml,md,mdx}: BrowseCentral labels should be maximum 3-5 words - keep concise but add context when needed
BrowseCentral labels should be action-oriented - start with verbs when possible
BrowseCentral labels should be specific and clear - add context when simple labels are ambiguous
BrowseCentral labels should be outcome-focused - describe what users accomplish and the context
BrowseCentral labels should use 'Action + Object' pattern (e.g., 'Invite users', 'Restrict sign-up', 'Set up SCIM')
BrowseCentral labels should use feature names (e.g., 'Enterprise SSO', 'Passwordless quickstart')
BrowseCentral labels should describe task completion (e.g., 'Run migrations', 'Migrate auth', 'Merge identities')
BrowseCentral labels should include specific context when needed (e.g., 'Configure Scalekit MCP server', 'Validate incoming API requests')
BrowseCentral labels should use integration context when applicable (e.g., 'Build MCP auth with your existing auth system')
BrowseCentral labels should avoid instructional prefixes: 'How to', 'Guide to', 'Implement', 'Configure', 'Learn', 'Understand'
BrowseCentral labels should avoid verbose phrases: 'Step-by-step guide', 'Complete tutorial', 'Detailed documentation'
BrowseCentral labels should avoid weak verbs: 'Enable', 'Allow', 'Provide', 'Support'
Files:
src/content/docs/reference/agent-connectors/apollo.mdxsrc/components/templates/agent-connectors/_setup-apollo.mdx
**/*.{md,mdx}
📄 CodeRabbit inference engine (.cursor/rules/deno-docs-style.mdc)
**/*.{md,mdx}: Use sentence case for all titles and headings in MD/MDX documentation
Keep page titles short and descriptive (3–7 words when possible) in MD/MDX documentation
Use outcome-focused headings that describe results, not categories (e.g., 'Run a script' not 'Scripts')
Avoid gerunds in headings when an imperative works - prefer 'Configure proxies' over 'Configuring proxies'
Keep sidebar labels concise (1–3 words), use sentence case, and focus on outcomes or objects
Use sentence case in sidebar labels without punctuation
Set frontmatter title in sentence case with a clear outcome; description in one sentence (≤160 chars); sidebar.label as shorter form of title; enable tableOfContents on longer pages
Start documentation pages with a one-paragraph overview explaining what the page covers and when to use it
Present the primary use case (80% path) first in documentation, with edge cases later
Use numbered steps for task-focused sections in documentation, with each step beginning with a verb
Break up long documentation sections with subheadings every 3–6 paragraphs
Use asides for important notes, tips, cautions, and references in documentation
Provide runnable, minimal code examples that work as-is in documentation
Prefer CLI-first examples and show file layout when helpful in documentation
Label code blocks with titles for context (e.g., 'Terminal', 'main.ts') in documentation
Keep code block annotations brief and purposeful - annotate only what matters
Use consistent variable and file names across a documentation page
Use descriptive link text in documentation (e.g., 'See permission flags' not 'click here')
Prefer relative links for internal documentation pages and include anchors for section references
Reference APIs consistently using backticks for code, file names, CLI flags, and endpoints
Use backticks for code, file names, CLI flags, and endpoints in documentation
Use lists for options and features in documentation; tables only when comparisons are cleare...
Files:
src/content/docs/reference/agent-connectors/apollo.mdxsrc/components/templates/agent-connectors/_setup-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 (38)
📓 Common learnings
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 424
File: public/api/scalekit.scalar.json:3451-3457
Timestamp: 2026-02-10T05:32:59.967Z
Learning: In scalekit-inc/developer-docs, the file public/api/scalekit.scalar.json is a generated OpenAPI artifact; reviewers should avoid direct edits. For inconsistencies (e.g., the /api/v1/permissions "type" query param description vs. enum), handle short-term via release/PR notes and track long-term fixes in the generator or source templates rather than modifying the generated JSON.
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 415
File: src/content/docs/authenticate/fsa/multiapp/native-app.mdx:72-179
Timestamp: 2026-02-02T05:55:51.251Z
Learning: In the `src/content/docs/authenticate/fsa/multiapp/` directory, the multi-app authentication documentation (native-app.mdx, single-page-app.mdx, web-app.mdx, overview.mdx) currently uses conceptual shell/curl examples instead of multi-language SDK code examples because the Scalekit SDKs have not yet been built/updated for multi-app functionality. Once the SDKs are ready, these files should be updated to include all 4 languages (Node.js, Python, Go, Java) using `<Tabs syncKey="tech-stack">`.
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 exact SDK variable names: Node.js: `scalekit`, Python: `scalekit_client`, Go: `scalekitClient`, Java: `scalekitClient` in all documentation and code examples
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: 476
File: src/content/docs/guides/integrations/sso-integrations/okta-oidc.mdx:84-99
Timestamp: 2026-03-10T12:26:38.439Z
Learning: In scalekit-inc/developer-docs, integration guide pages under `src/content/docs/guides/integrations/` (including SSO integrations, SCIM integrations, and social connections) do not require a "what's next" signal, "Next steps" section, or concluding navigation links. Do not flag the absence of these elements on integration guide pages.
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursorrules:0-0
Timestamp: 2026-01-13T12:46:55.260Z
Learning: Applies to **/*.mdx : Use present tense for descriptions: 'Scalekit handles the complex authentication flow', 'The SDK provides methods to refresh tokens'
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.
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 consistent SDK variable naming: Node.js='scalekit', Python='scalekit_client', Go='scalekitClient', Java='scalekitClient'
📚 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.mdxsrc/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 **/*.{md,mdx} : Use exact SDK variable names: Node.js: `scalekit`, Python: `scalekit_client`, Go: `scalekitClient`, Java: `scalekitClient` in all documentation and code examples
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 consistent SDK variable naming: Node.js='scalekit', Python='scalekit_client', Go='scalekitClient', Java='scalekitClient'
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-10T05:32:59.967Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 424
File: public/api/scalekit.scalar.json:3451-3457
Timestamp: 2026-02-10T05:32:59.967Z
Learning: In scalekit-inc/developer-docs, the file public/api/scalekit.scalar.json is a generated OpenAPI artifact; reviewers should avoid direct edits. For inconsistencies (e.g., the /api/v1/permissions "type" query param description vs. enum), handle short-term via release/PR notes and track long-term fixes in the generator or source templates rather than modifying the generated JSON.
Applied to files:
src/content/docs/reference/agent-connectors/apollo.mdx
📚 Learning: 2026-02-02T05:55:51.251Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 415
File: src/content/docs/authenticate/fsa/multiapp/native-app.mdx:72-179
Timestamp: 2026-02-02T05:55:51.251Z
Learning: In the `src/content/docs/authenticate/fsa/multiapp/` directory, the multi-app authentication documentation (native-app.mdx, single-page-app.mdx, web-app.mdx, overview.mdx) currently uses conceptual shell/curl examples instead of multi-language SDK code examples because the Scalekit SDKs have not yet been built/updated for multi-app functionality. Once the SDKs are ready, these files should be updated to include all 4 languages (Node.js, Python, Go, Java) using `<Tabs syncKey="tech-stack">`.
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 present tense for descriptions: 'Scalekit handles the complex authentication flow', 'The SDK provides methods to refresh tokens'
Applied to files:
src/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/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: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-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-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-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-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.mdxsrc/components/templates/agent-connectors/_setup-apollo.mdx
📚 Learning: 2026-02-25T18:41:00.639Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 446
File: src/content/docs/authenticate/m2m/api-auth-quickstart.mdx:78-78
Timestamp: 2026-02-25T18:41:00.639Z
Learning: Preserve full URLs inside code comments in MDX code blocks (bash/python/js) when the URLs are part of copyable examples. Do not flag these in code examples. Use relative paths in prose and hyperlinks within MDX; only enforce relative paths for markdown prose links, not for URLs inside code comments.
Applied to files:
src/content/docs/reference/agent-connectors/apollo.mdxsrc/components/templates/agent-connectors/_setup-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: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: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-03-10T10:37:47.033Z
Learnt from: Pranesh-Raghu
Repo: scalekit-inc/developer-docs PR: 475
File: src/components/templates/agent-connectors/_setup-asana.mdx:15-15
Timestamp: 2026-03-10T10:37:47.033Z
Learning: In src/components/templates/agent-connectors/**/*.mdx, it is acceptable to reuse a single shared redirect URI screenshot (use-own-credentials-redirect-uri.png) across multiple steps within the same connector file, even if different UIs are shown. Do not flag this reuse as an issue; ensure this behavior is intentional and documented for reviewers.
Applied to files:
src/components/templates/agent-connectors/_setup-apollo.mdx
📚 Learning: 2026-03-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/_setup-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/components/templates/agent-connectors/_setup-apollo.mdx
📚 Learning: 2026-01-13T12:46:55.260Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursorrules:0-0
Timestamp: 2026-01-13T12:46:55.260Z
Learning: Applies to **/*.mdx : Include configuration comments in code examples: '// Get the signing secret from Scalekit dashboard > Interceptors tab'
Applied to files:
src/components/templates/agent-connectors/_setup-apollo.mdx
📚 Learning: 2026-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 : Aside components within Steps must be indented with 3 spaces to avoid Steps component parsing errors
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/configs/sidebar.config.ts,src/components/**/*.astro} : Navigation is configured via `src/configs/sidebar.config.ts`. Changes to navigation structure MUST be coordinated across both sidebar.config.ts and `src/components/SecondaryNav.astro` configurations.
Applied to files:
src/components/templates/agent-connectors/_setup-apollo.mdx
📚 Learning: 2026-02-26T07:21:37.207Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 448
File: src/content/docs/reference/agent-connectors/googlesheets.mdx:89-131
Timestamp: 2026-02-26T07:21:37.207Z
Learning: In src/content/docs/reference/agent-connectors/** MDX files, tool headings (e.g., `googlesheets_create_spreadsheet`, `googlesheets_get_values`) intentionally use H2 (##) instead of H3 to ensure they appear in the table of contents for easier navigation. This is a deliberate UX choice for agent connector reference pages and should not be flagged as a hierarchy issue.
Applied to files:
src/components/templates/agent-connectors/_setup-apollo.mdx
📚 Learning: 2026-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 Aside component for notes, warnings, and tips in MDX documentation
Applied to files:
src/components/templates/agent-connectors/_setup-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 Steps component for sequential instructions in MDX documentation
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 : Ensure no trailing whitespace on empty lines within Steps components to avoid 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 : Use Aside components for important notes, tips, and warnings in MDX documentation
Applied to files:
src/components/templates/agent-connectors/_setup-apollo.mdx
📚 Learning: 2026-03-10T12:26:38.439Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 476
File: src/content/docs/guides/integrations/sso-integrations/okta-oidc.mdx:84-99
Timestamp: 2026-03-10T12:26:38.439Z
Learning: In scalekit-inc/developer-docs, integration guide pages under `src/content/docs/guides/integrations/` (including SSO integrations, SCIM integrations, and social connections) do not require a "what's next" signal, "Next steps" section, or concluding navigation links. Do not flag the absence of these elements on integration guide pages.
Applied to files:
src/components/templates/agent-connectors/_setup-apollo.mdx
📚 Learning: 2026-02-26T07:21:12.772Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 448
File: src/content/docs/reference/agent-connectors/googlesheets.mdx:82-82
Timestamp: 2026-02-26T07:21:12.772Z
Learning: For agent connector documentation files under src/content/docs/reference/agent-connectors/, prefer CDN URLs (https://cdn.scalekit.cloud/sk-connect/assets/provider-icons/) for connector logo images rather than storing them locally in src/assets/docs/. This differs from the general guideline to use local assets.
Applied to files:
src/components/templates/agent-connectors/_setup-apollo.mdx
📚 Learning: 2026-03-10T10:38:27.783Z
Learnt from: Pranesh-Raghu
Repo: scalekit-inc/developer-docs PR: 475
File: src/components/templates/agent-connectors/_setup-confluence.mdx:16-16
Timestamp: 2026-03-10T10:38:27.783Z
Learning: In all MDX templates under src/components/templates/agent-connectors, the pattern uses empty alt text (e.g., ![]()) for redirect URI screenshots like use-own-credentials-redirect-uri.png. This is intentional; reviews should not flag missing alt text for these images in this directory.
Applied to files:
src/components/templates/agent-connectors/_setup-apollo.mdx
📚 Learning: 2026-03-10T10:38:30.012Z
Learnt from: Pranesh-Raghu
Repo: scalekit-inc/developer-docs PR: 475
File: src/components/templates/agent-connectors/_setup-clickup.mdx:17-17
Timestamp: 2026-03-10T10:38:30.012Z
Learning: In the repository's agent-connectors setup template files (src/components/templates/agent-connectors/_setup-*.mdx), the pattern for redirect URI screenshot images is to use empty alt text (![]()). Do not flag missing alt text for these specific Markdown image syntaxes in the agent connector setup template files. This guidance applies only to files matching this setup-*.mdx naming pattern; other templates should continue to enforce standard alt text practices.
Applied to files:
src/components/templates/agent-connectors/_setup-apollo.mdx
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
src/content/docs/reference/agent-connectors/apollo.mdx (2)
113-127: 🛠️ Refactor suggestion | 🟠 MajorAdd the failure path to both runnable examples.
These snippets show the full auth-and-request flow, but they only cover the happy path. Add
try/catchandtry/excepthandling around link generation and the proxied request so readers can see how to handle auth refusal and upstream API failures. As per coding guidelines, "Show both success path AND error path in every code example."Also applies to: 146-160
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/content/docs/reference/agent-connectors/apollo.mdx` around lines 113 - 127, Wrap the happy-path calls to scalekit.connectedAccounts.getMagicLinkForConnectedAccount and scalekit.actions.request in appropriate error handling: add a try/catch around the magic-link generation (referencing scalekit.connectedAccounts.getMagicLinkForConnectedAccount, connectionName, identifier, and link) to log or surface authorization refusal, and add a separate try/catch around the proxied request (scalekit.actions.request, connectionName, identifier, and result) to handle upstream API failures; do the same for the second snippet (the Python/try/except variant) so each example shows both success and failure paths and logs/errors are clear and actionable.
114-125:⚠️ Potential issue | 🟠 MajorFix API method and path inconsistencies between Node.js and Python examples.
The Node.js and Python tabs use different API surfaces:
- Node.js calls
scalekit.connectedAccounts.getMagicLinkForConnectedAccount()with path/v1/contacts/search- Python calls
scalekit_client.actions.get_authorization_link()with path/api/v1/contacts/searchThe Python approach is correct. The Node.js example should either:
- Match the Python method signature if both SDKs support
actions.get_authorization_link(), or- Use the correct path
/api/v1/contacts/search(Apollo's endpoint requires the/apiprefix)Verify with the Node.js SDK maintainer whether the method names intentionally diverge or if the Node.js tab reflects stale API surface.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/content/docs/reference/agent-connectors/apollo.mdx` around lines 114 - 125, Update the Node.js example to match the Python example's API surface and endpoint: either switch the Node.js call to the equivalent authorization helper if available (e.g., replace scalekit.connectedAccounts.getMagicLinkForConnectedAccount with the SDK's authorization helper matching scalekit_client.actions.get_authorization_link), or if that helper doesn't exist, change the request path used in scalekit.actions.request from '/v1/contacts/search' to '/api/v1/contacts/search' so it matches Apollo's required '/api' prefix; confirm with the Node.js SDK maintainer which method name is correct and make the Node.js sample use the same method signature and '/api/v1/contacts/search' path as the Python example.
🤖 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`:
- Line 99: The two fenced code blocks in the Apollo docs are missing the
required file-context title; update the opening fences for the TypeScript and
Python examples by adding title="examples/apollo.ts" to the ```typescript fence
and title="examples/apollo.py" to the ```python fence so each code block
includes the required file path title attribute.
---
Outside diff comments:
In `@src/content/docs/reference/agent-connectors/apollo.mdx`:
- Around line 113-127: Wrap the happy-path calls to
scalekit.connectedAccounts.getMagicLinkForConnectedAccount and
scalekit.actions.request in appropriate error handling: add a try/catch around
the magic-link generation (referencing
scalekit.connectedAccounts.getMagicLinkForConnectedAccount, connectionName,
identifier, and link) to log or surface authorization refusal, and add a
separate try/catch around the proxied request (scalekit.actions.request,
connectionName, identifier, and result) to handle upstream API failures; do the
same for the second snippet (the Python/try/except variant) so each example
shows both success and failure paths and logs/errors are clear and actionable.
- Around line 114-125: Update the Node.js example to match the Python example's
API surface and endpoint: either switch the Node.js call to the equivalent
authorization helper if available (e.g., replace
scalekit.connectedAccounts.getMagicLinkForConnectedAccount with the SDK's
authorization helper matching scalekit_client.actions.get_authorization_link),
or if that helper doesn't exist, change the request path used in
scalekit.actions.request from '/v1/contacts/search' to '/api/v1/contacts/search'
so it matches Apollo's required '/api' prefix; confirm with the Node.js SDK
maintainer which method name is correct and make the Node.js sample use the same
method signature and '/api/v1/contacts/search' path as the Python example.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: f0675822-6025-44e1-aec1-81c0779fd1f9
📒 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 (28)
📓 Common learnings
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 424
File: public/api/scalekit.scalar.json:3451-3457
Timestamp: 2026-02-10T05:32:59.967Z
Learning: In scalekit-inc/developer-docs, the file public/api/scalekit.scalar.json is a generated OpenAPI artifact; reviewers should avoid direct edits. For inconsistencies (e.g., the /api/v1/permissions "type" query param description vs. enum), handle short-term via release/PR notes and track long-term fixes in the generator or source templates rather than modifying the generated JSON.
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 415
File: src/content/docs/authenticate/fsa/multiapp/native-app.mdx:72-179
Timestamp: 2026-02-02T05:55:51.251Z
Learning: In the `src/content/docs/authenticate/fsa/multiapp/` directory, the multi-app authentication documentation (native-app.mdx, single-page-app.mdx, web-app.mdx, overview.mdx) currently uses conceptual shell/curl examples instead of multi-language SDK code examples because the Scalekit SDKs have not yet been built/updated for multi-app functionality. Once the SDKs are ready, these files should be updated to include all 4 languages (Node.js, Python, Go, Java) using `<Tabs syncKey="tech-stack">`.
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 exact SDK variable names: Node.js: `scalekit`, Python: `scalekit_client`, Go: `scalekitClient`, Java: `scalekitClient` in all documentation and code examples
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: 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.
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 476
File: src/content/docs/guides/integrations/sso-integrations/okta-oidc.mdx:84-99
Timestamp: 2026-03-10T12:26:38.439Z
Learning: In scalekit-inc/developer-docs, integration guide pages under `src/content/docs/guides/integrations/` (including SSO integrations, SCIM integrations, and social connections) do not require a "what's next" signal, "Next steps" section, or concluding navigation links. Do not flag the absence of these elements on integration guide pages.
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursorrules:0-0
Timestamp: 2026-01-13T12:46:55.260Z
Learning: Applies to **/*.mdx : Use present tense for descriptions: 'Scalekit handles the complex authentication flow', 'The SDK provides methods to refresh tokens'
📚 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 exact SDK variable names: Node.js: `scalekit`, Python: `scalekit_client`, Go: `scalekitClient`, Java: `scalekitClient` in all documentation and code examples
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-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 consistent SDK variable naming: Node.js='scalekit', Python='scalekit_client', Go='scalekitClient', Java='scalekitClient'
Applied to files:
src/content/docs/reference/agent-connectors/apollo.mdx
📚 Learning: 2026-02-02T05:55:51.251Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 415
File: src/content/docs/authenticate/fsa/multiapp/native-app.mdx:72-179
Timestamp: 2026-02-02T05:55:51.251Z
Learning: In the `src/content/docs/authenticate/fsa/multiapp/` directory, the multi-app authentication documentation (native-app.mdx, single-page-app.mdx, web-app.mdx, overview.mdx) currently uses conceptual shell/curl examples instead of multi-language SDK code examples because the Scalekit SDKs have not yet been built/updated for multi-app functionality. Once the SDKs are ready, these files should be updated to include all 4 languages (Node.js, Python, Go, Java) using `<Tabs syncKey="tech-stack">`.
Applied to files:
src/content/docs/reference/agent-connectors/apollo.mdx
📚 Learning: 2026-02-10T05:32:59.967Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 424
File: public/api/scalekit.scalar.json:3451-3457
Timestamp: 2026-02-10T05:32:59.967Z
Learning: In scalekit-inc/developer-docs, the file public/api/scalekit.scalar.json is a generated OpenAPI artifact; reviewers should avoid direct edits. For inconsistencies (e.g., the /api/v1/permissions "type" query param description vs. enum), handle short-term via release/PR notes and track long-term fixes in the generator or source templates rather than modifying the generated JSON.
Applied to files:
src/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-01-13T12:46:55.260Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursorrules:0-0
Timestamp: 2026-01-13T12:46:55.260Z
Learning: Applies to **/*.mdx : Use present tense for descriptions: 'Scalekit handles the complex authentication flow', 'The SDK provides methods to refresh tokens'
Applied to files:
src/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/content/docs/reference/agent-connectors/apollo.mdx
📚 Learning: 2026-03-10T12:26:38.439Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 476
File: src/content/docs/guides/integrations/sso-integrations/okta-oidc.mdx:84-99
Timestamp: 2026-03-10T12:26:38.439Z
Learning: In scalekit-inc/developer-docs, integration guide pages under `src/content/docs/guides/integrations/` (including SSO integrations, SCIM integrations, and social connections) do not require a "what's next" signal, "Next steps" section, or concluding navigation links. Do not flag the absence of these elements on integration guide pages.
Applied to files:
src/content/docs/reference/agent-connectors/apollo.mdx
📚 Learning: 2026-03-10T10:37:49.873Z
Learnt from: Pranesh-Raghu
Repo: scalekit-inc/developer-docs PR: 475
File: src/components/templates/agent-connectors/_setup-asana.mdx:15-15
Timestamp: 2026-03-10T10:37:49.873Z
Learning: In `src/components/templates/agent-connectors/`, all connector setup MDX files (e.g., _setup-asana.mdx, _setup-clickup.mdx, _setup-confluence.mdx, _setup-googlecalendar.mdx, _setup-intercom.mdx, _setup-monday.mdx, _setup-notion.mdx, _setup-zoom.mdx) intentionally use a single shared redirect URI screenshot (`use-own-credentials-redirect-uri.png` located under `@/assets/docs/agent-connectors/<connector-name>/`) for all redirect URI-related steps, even when steps show different UIs (e.g., Scalekit dashboard vs. the third-party console). Do not flag reuse of this image across multiple steps within the same connector file as an issue.
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-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-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-03-10T10:38:35.371Z
Learnt from: Pranesh-Raghu
Repo: scalekit-inc/developer-docs PR: 475
File: src/components/templates/agent-connectors/_setup-confluence.mdx:16-16
Timestamp: 2026-03-10T10:38:35.371Z
Learning: In `src/components/templates/agent-connectors/_setup-*.mdx` files, empty alt text `![]()` for redirect URI screenshots (e.g., `use-own-credentials-redirect-uri.png`) is a deliberate and consistent pattern across all connector setup template files. Do not flag missing alt text on these images in future reviews of files under `src/components/templates/agent-connectors/`.
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: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-03-10T10:38:36.402Z
Learnt from: Pranesh-Raghu
Repo: scalekit-inc/developer-docs PR: 475
File: src/components/templates/agent-connectors/_setup-clickup.mdx:17-17
Timestamp: 2026-03-10T10:38:36.402Z
Learning: In `src/components/templates/agent-connectors/_setup-*.mdx` template files, empty alt text `![]()` is the established pattern for redirect URI screenshot images. Do not flag missing alt text on `![]()` markdown image syntax in these agent connector setup template files.
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-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-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-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-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
📚 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
🔇 Additional comments (1)
src/content/docs/reference/agent-connectors/apollo.mdx (1)
103-115: Clarify thatconnectoris the provider slug.
connectionName/connection_nameplus the current comment still reads like a dashboard-defined alias. Rename the variable or update the comment so readers know theconnectorvalue is the fixed Apollo provider identifier, not a user-customizable connection name.Also applies to: 136-148
✅ Deploy Preview for scalekit-starlight ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for scalekit-starlight ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
1 participant
Summary by CodeRabbit