Update Node.js docs to use actions API#514
Conversation
Update Node.js examples to match the updated SDK API: replace connectedAccounts client with scalekit.actions, rename connector -> connectionName, rename getMagicLinkForConnectedAccount -> getAuthorizationLink, getConnectedAccountByIdentifier -> getConnectedAccount, and update list/delete calls to actions.*. Remove the beta-specific npm install note and use the stable @scalekit-sdk/node package, and simplify status checks to use the 'ACTIVE' string. These changes align the docs with the latest Node SDK method names and usage.
dhaneshbs
requested review from
amitash1912,
ravibits and
saif-at-scalekit
as code owners
|
Caution Review failedPull request was closed or merged during review 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 (3)**/*.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:
🧠 Learnings (24)📓 Common learnings📚 Learning: 2026-03-20T02:32:39.716ZApplied to files:
📚 Learning: 2026-03-03T13:35:56.400ZApplied to files:
📚 Learning: 2026-03-12T05:02:06.063ZApplied to files:
📚 Learning: 2026-03-12T05:02:06.063ZApplied to files:
📚 Learning: 2026-02-26T07:21:37.207ZApplied to files:
📚 Learning: 2026-02-26T07:20:46.903ZApplied to files:
📚 Learning: 2026-02-26T07:23:27.672ZApplied to files:
📚 Learning: 2026-02-02T05:55:51.251ZApplied to files:
📚 Learning: 2026-03-12T16:29:16.422ZApplied to files:
📚 Learning: 2026-02-26T07:22:55.583ZApplied to files:
📚 Learning: 2026-03-10T10:37:49.873ZApplied to files:
📚 Learning: 2026-03-12T16:26:46.707ZApplied to files:
📚 Learning: 2026-03-09T07:32:38.426ZApplied to files:
📚 Learning: 2026-03-09T15:06:49.617ZApplied 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-17T16:01:50.487ZApplied to files:
📚 Learning: 2026-02-25T03:34:41.147ZApplied to files:
📚 Learning: 2026-02-25T18:41:00.639ZApplied to files:
🔇 Additional comments (11)
WalkthroughDocumentation-only updates: Node.js examples moved from Changes
Sequence Diagram(s)(omitted — changes are documentation-only API renames and do not introduce new multi-component control flow) Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan
Comment |
Update docs examples in authorize.mdx to use the new actions client and parameter naming. Replace connectedAccounts.getMagicLinkForConnectedAccount with actions.getAuthorizationLink and rename the connector parameter to connectionName; also switch connectedAccounts.getOrCreateConnectedAccount to actions.getOrCreateConnectedAccount.
Update the Node.js example to reflect API changes: replace tools.executeTool with actions.executeTool, rename the request field from params to toolInput, and remove an outdated npm install comment. Keeps the docs aligned with current SDK usage.
✅ Deploy Preview for scalekit-starlight ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
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/agent-auth/connected-accounts.mdx (1)
254-268:⚠️ Potential issue | 🟠 MajorUse the documented refresh API before sending users back through OAuth.
The current code at lines 254-268 sends users directly to
getAuthorizationLink()when an account is notACTIVE, but the Token Management guide documentsrefreshConnectedAccount(Node.js) /refresh_connected_account(Python) as the correct path to manually refresh tokens before attempting re-authorization. The error handling in that guide shows re-authentication as a fallback only when refresh fails. This example should attempt a refresh call first, matching the documented token lifecycle and avoiding unnecessary full OAuth flows.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/content/docs/agent-auth/connected-accounts.mdx` around lines 254 - 268, The example jumps straight to getAuthorizationLink when connectedAccount.status !== 'ACTIVE' instead of attempting a token refresh first; update the logic in the block that uses getOrCreateConnectedAccount so it calls refreshConnectedAccount (Node.js name) for the same connectionName/identifier and checks its result, only falling back to getAuthorizationLink if refreshConnectedAccount fails or indicates re-auth is required; ensure you reference the same connectionName ('gmail') and identifier ('user_123'), handle errors from refreshConnectedAccount, and log or return the authorization link only as a fallback.
🤖 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/agent-auth/connected-accounts.mdx`:
- Line 379: The text and example incorrectly present
get_or_create_connected_account as a read-only retrieval; change the sentence at
line 379 to state that read-only retrieval uses get_connected_account (Python) /
getConnectedAccount (Node.js) while get_or_create_connected_account performs
create-or-retrieve semantics, and update the code example (which currently calls
get_or_create_connected_account with the comment "Retrieve an individual
account") to call get_connected_account (or getConnectedAccount) instead so the
example reflects a pure read-only lookup; leave mentions of bulk list/delete
(actions.listConnectedAccounts, actions.deleteConnectedAccount) unchanged.
In `@src/content/docs/agent-auth/quickstart.mdx`:
- Around line 220-235: The Node.js snippet unconditionally logs sensitive OAuth
tokens (accessToken/refreshToken) and should match the Python pattern: remove
unconditional console.log calls for accessToken and refreshToken and either omit
printing tokens or guard them behind a development-only check (e.g.,
NODE_ENV==='development' or a debug flag) so they never appear in production;
add a short inline security warning comment near the extraction (around
accountResponse, authDetails, accessToken, refreshToken) advising not to log
tokens in production and showing the safe conditional logging approach used in
the Python tab.
- Line 82: Update the installation command string "npm install
`@scalekit-sdk/node`" to pin the beta release by changing it to "npm install
`@scalekit-sdk/node`@2.2.0-beta.1" so Agent Auth features use the beta SDK; locate
the occurrence of that exact install command in the quickstart content and
replace it to match other Agent Auth docs (e.g., agent-tools-quickstart) for
consistency.
---
Outside diff comments:
In `@src/content/docs/agent-auth/connected-accounts.mdx`:
- Around line 254-268: The example jumps straight to getAuthorizationLink when
connectedAccount.status !== 'ACTIVE' instead of attempting a token refresh
first; update the logic in the block that uses getOrCreateConnectedAccount so it
calls refreshConnectedAccount (Node.js name) for the same
connectionName/identifier and checks its result, only falling back to
getAuthorizationLink if refreshConnectedAccount fails or indicates re-auth is
required; ensure you reference the same connectionName ('gmail') and identifier
('user_123'), handle errors from refreshConnectedAccount, and log or return the
authorization link only as a fallback.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: aae552a2-c22c-4da9-a7d3-1530cfed2147
📒 Files selected for processing (2)
src/content/docs/agent-auth/connected-accounts.mdxsrc/content/docs/agent-auth/quickstart.mdx
📜 Review details
🧰 Additional context used
📓 Path-based instructions (3)
**/*.mdx
📄 CodeRabbit inference engine (.cursorrules)
**/*.mdx: Use clear, descriptive titles that explain the purpose of the document
Include comprehensive descriptions in frontmatter metadata
Organize content with logical heading hierarchy (H2, H3, H4)
Use tableOfContents property in frontmatter when content has multiple sections
Set appropriate sidebar labels for navigation in frontmatter
Use direct instruction writing style with phrases like 'This guide shows you how to...' and 'Create an authorization URL to...'
Use second person perspective ('your application', 'you receive', 'you must') in documentation
Keep sentences concise, aiming for under 25 words per sentence
Explain the 'why' in documentation with phrases like 'This prevents CSRF attacks by...' or 'Use this to validate that...'
Use action verbs in section headings: 'Store session tokens securely', 'Validate the state parameter', 'Exchange authorization code for tokens'
Use present tense for descriptions: 'Scalekit handles the complex authentication flow', 'The SDK provides methods to refresh tokens'
Use future tense for results: 'This will redirect users to...', 'You'll receive a JWT containing...', 'Scalekit returns an authorization code'
Use transition phrases between sections: 'After the user authenticates...', 'Once the state is validated...', 'Let's take a look at how to...'
Write 1-3 opening paragraphs that explain what users will accomplish, provide context about when/why, preview key concepts, and use direct instructional language
Begin introduction sections with a clear statement of what the guide covers and explain the problem being solved
Use collapsible sections in introduction for sequence diagrams, video demonstrations, data models, and JSON examples with appropriate icons
Use numbered format within Steps component:1. ## Titlewith all step content indented with exactly 3 spaces
Use action-oriented headings in step-by-step guides within Steps components
Include code examples in all 4 languages (Node.js, Python, Go, Java) within Steps co...
Files:
src/content/docs/agent-auth/quickstart.mdxsrc/content/docs/agent-auth/connected-accounts.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/agent-auth/quickstart.mdxsrc/content/docs/agent-auth/connected-accounts.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/agent-auth/quickstart.mdxsrc/content/docs/agent-auth/connected-accounts.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/agent-auth/quickstart.mdxsrc/content/docs/agent-auth/connected-accounts.mdx
🧠 Learnings (31)
📓 Common learnings
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: 455
File: src/content/docs/reference/agent-connectors/asana.mdx:94-173
Timestamp: 2026-03-03T13:35:56.400Z
Learning: For Agent Connectors documentation (src/content/docs/reference/agent-connectors/**/*.mdx), currently only Python SDK support is available for Agent Actions/Agent Connectors. Do not require or enforce the multi-language SDK code examples (Node.js, Python, Go, Java) guideline for these connector docs until SDK support is ready in other languages. The Node.js, Go, and Java examples can be added once the respective SDKs support Agent Actions features.
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-03-17T11:36:10.761Z
Learning: Applies to **/*.{md,mdx} : Use exact SDK variable names in documentation and code examples: Node.js: `scalekit`, Python: `scalekit_client`, Go: `scalekitClient`, Java: `scalekitClient`
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">`.
📚 Learning: 2026-02-25T13:32:58.695Z
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:32:58.695Z
Learning: In all Agent Auth documentation under src/content/docs/agent-auth, specify that the Node.js SDK installation must be scalekit-sdk/node2.2.0-beta.1 because Agent Auth features are only available in the beta version and not in the latest stable release. Do not flag these docs as issues or suggest upgrading to stable versions.
Applied to files:
src/content/docs/agent-auth/quickstart.mdxsrc/content/docs/agent-auth/connected-accounts.mdx
📚 Learning: 2026-03-17T11:36:10.761Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-03-17T11:36:10.761Z
Learning: Applies to **/*.{md,mdx} : Use exact SDK variable names in documentation and code examples: Node.js: `scalekit`, Python: `scalekit_client`, Go: `scalekitClient`, Java: `scalekitClient`
Applied to files:
src/content/docs/agent-auth/quickstart.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/agent-auth/quickstart.mdxsrc/content/docs/agent-auth/connected-accounts.mdx
📚 Learning: 2026-03-03T13:35:56.400Z
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.
Applied to files:
src/content/docs/agent-auth/quickstart.mdxsrc/content/docs/agent-auth/connected-accounts.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/agent-auth/quickstart.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/agent-auth/quickstart.mdx
📚 Learning: 2026-03-09T15:06:49.617Z
Learnt from: hrishikesh-p
Repo: scalekit-inc/developer-docs PR: 473
File: src/content/docs/agent-auth/tools/execute.mdx:34-76
Timestamp: 2026-03-09T15:06:49.617Z
Learning: In src/content/docs/agent-auth/tools/**/*.mdx (Agent Auth tool execution docs, e.g., execute.mdx, authorize.mdx), only Python and Node.js SDK support is currently available for Agent Auth tool execution. Do not require or enforce Go and Java tabs in Tabs syncKey="tech-stack" blocks for these files until the Go and Java SDKs support Agent Auth features. Add Go and Java TabItems once those SDKs are ready.
Applied to files:
src/content/docs/agent-auth/quickstart.mdxsrc/content/docs/agent-auth/connected-accounts.mdx
📚 Learning: 2026-03-12T16:28:42.817Z
Learnt from: Pranesh-Raghu
Repo: scalekit-inc/developer-docs PR: 483
File: src/components/templates/agent-connectors/_setup-zendesk.mdx:20-20
Timestamp: 2026-03-12T16:28:42.817Z
Learning: In src/components/templates/agent-connectors/_setup-*.mdx files, using plain Markdown link syntax (e.g., [Scalekit dashboard](https://app.scalekit.com)) for external links is acceptable and intentional. Do not flag the absence of target="_blank" and rel="noopener" attributes in these agent-connector setup template files. This follows the established pattern across all connector templates in this directory.
Applied to files:
src/content/docs/agent-auth/quickstart.mdx
📚 Learning: 2026-03-13T03:51:44.897Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 489
File: src/content/docs/reference/agent-connectors/attio.mdx:24-24
Timestamp: 2026-03-13T03:51:44.897Z
Learning: For any agent connector documentation files located in src/content/docs/reference/agent-connectors/, use CDN URLs for connector logos with the host `https://cdn.scalekit.com/sk-connect/assets/provider-icons/` (e.g., `https://cdn.scalekit.com/sk-connect/assets/provider-icons/attio.svg`). The correct host is `cdn.scalekit.com`, NOT `cdn.scalekit.cloud`. Do not flag or change image src attributes that use `cdn.scalekit.com` for provider icons in this directory.
Applied to files:
src/content/docs/agent-auth/quickstart.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/agent-auth/quickstart.mdx
📚 Learning: 2026-03-17T11:36:10.761Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-03-17T11:36:10.761Z
Learning: Applies to **/*.{md,mdx} : Use `<Tabs syncKey="tech-stack">` format for multi-language SDK samples in documentation
Applied to files:
src/content/docs/agent-auth/quickstart.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 Tab labels for multi-language examples: 'Node.js', 'Python', 'Go', 'Java' with TabItem values 'node', 'python'/'py', 'go'/'golang', 'java'
Applied to files:
src/content/docs/agent-auth/quickstart.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 `<Tabs syncKey="tech-stack">` to synchronize multi-language code selection across documentation pages
Applied to files:
src/content/docs/agent-auth/quickstart.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/agent-auth/quickstart.mdxsrc/content/docs/agent-auth/connected-accounts.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/agent-auth/quickstart.mdxsrc/content/docs/agent-auth/connected-accounts.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/agent-auth/quickstart.mdxsrc/content/docs/agent-auth/connected-accounts.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/agent-auth/quickstart.mdxsrc/content/docs/agent-auth/connected-accounts.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/agent-auth/quickstart.mdxsrc/content/docs/agent-auth/connected-accounts.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/agent-auth/quickstart.mdxsrc/content/docs/agent-auth/connected-accounts.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/agent-auth/quickstart.mdxsrc/content/docs/agent-auth/connected-accounts.mdx
📚 Learning: 2026-03-17T16:01:50.487Z
Learnt from: dhaneshbs
Repo: scalekit-inc/developer-docs PR: 506
File: src/content/docs/authenticate/fsa/quickstart.mdx:851-853
Timestamp: 2026-03-17T16:01:50.487Z
Learning: In the Scalekit Python SDK docs, clarify that LogoutUrlOptions is not exported from the top-level scalekit package __init__.py. The correct import path in code samples or reviews is: from scalekit.common.scalekit import LogoutUrlOptions. Do not flag this import path as incorrect in documentation or code reviews; ensure examples reflect the proper import path to avoid confusion for users.
Applied to files:
src/content/docs/agent-auth/quickstart.mdxsrc/content/docs/agent-auth/connected-accounts.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/agent-auth/quickstart.mdxsrc/content/docs/agent-auth/connected-accounts.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/agent-auth/quickstart.mdxsrc/content/docs/agent-auth/connected-accounts.mdx
📚 Learning: 2026-03-12T05:02:06.063Z
Learnt from: dhaneshbs
Repo: scalekit-inc/developer-docs PR: 487
File: src/content/docs/agent-auth/connections.mdx:0-0
Timestamp: 2026-03-12T05:02:06.063Z
Learning: In Agent Auth documentation (e.g., src/content/docs/agent-auth/connections.mdx and related agent-auth docs), custom authentication flows (username/password/bearer-token) are out of scope for the current Agent Auth release. Do not flag missing or undocumented custom authentication in Agent Auth connection-type sections; reviewers should treat absence as intentional and scope-compliant rather than a gap to fix.
Applied to files:
src/content/docs/agent-auth/quickstart.mdxsrc/content/docs/agent-auth/connected-accounts.mdx
📚 Learning: 2026-03-12T05:02:06.063Z
Learnt from: dhaneshbs
Repo: scalekit-inc/developer-docs PR: 487
File: src/content/docs/agent-auth/connections.mdx:0-0
Timestamp: 2026-03-12T05:02:06.063Z
Learning: In Agent Auth documentation (src/content/docs/agent-auth/**/), custom authentication flows (username/password/bearer-token) are out of scope for the current Agent Auth release. Do not flag the absence of custom authentication connection-type documentation in Agent Auth connection-type sections. Apply this guideline broadly to Agent Auth docs (not just this file).
Applied to files:
src/content/docs/agent-auth/quickstart.mdxsrc/content/docs/agent-auth/connected-accounts.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/content/docs/agent-auth/connected-accounts.mdx
📚 Learning: 2026-02-26T07:22:55.583Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 448
File: src/content/docs/reference/agent-connectors/googlesheets.mdx:95-141
Timestamp: 2026-02-26T07:22:55.583Z
Learning: For MDX files under src/content/docs/reference/agent-connectors/, the parameter tables (showing tool properties) are auto-generated from JSON API responses by scripts/sync-agent-connectors.js. Any table format corrections must be made in the generation script, not by manually editing the generated MDX files. The script should be updated to output the required "Name | Type | Required | Description" four-column table format per coding guidelines.
Applied to files:
src/content/docs/agent-auth/connected-accounts.mdx
📚 Learning: 2026-02-26T07:23:27.672Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 448
File: src/content/docs/reference/agent-connectors/microsoftword.mdx:3-3
Timestamp: 2026-02-26T07:23:27.672Z
Learning: For MDX files under src/content/docs/reference/agent-connectors/, do not enforce the 160-character description limit. These files are auto-generated from API payloads via scripts/sync-agent-connectors.js and may have longer descriptions from the source data.
Applied to files:
src/content/docs/agent-auth/connected-accounts.mdx
📚 Learning: 2026-03-12T16:29:16.422Z
Learnt from: Pranesh-Raghu
Repo: scalekit-inc/developer-docs PR: 483
File: src/components/templates/agent-connectors/_setup-onenote.mdx:12-12
Timestamp: 2026-03-12T16:29:16.422Z
Learning: In src/components/templates/agent-connectors/_setup-*.mdx files, using "Azure Active Directory" instead of the rebranded "Microsoft Entra ID" is acceptable and intentional. Do not flag "Azure Active Directory" as outdated branding in these agent-connector setup template files.
Applied to files:
src/content/docs/agent-auth/connected-accounts.mdx
📚 Learning: 2026-02-26T07:20:46.903Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 448
File: src/content/docs/reference/agent-connectors/googlemeet.mdx:1-87
Timestamp: 2026-02-26T07:20:46.903Z
Learning: For auto-generated agent connector documentation pages in src/content/docs/reference/agent-connectors/, the "what's next" signal requirement (next: frontmatter link, <LinkCard>, or concluding paragraph) does not apply. These are reference pages generated by scripts/sync-agent-connectors.js and serve as lookup resources rather than sequential guides.
Applied to files:
src/content/docs/agent-auth/connected-accounts.mdx
🔇 Additional comments (1)
src/content/docs/agent-auth/connected-accounts.mdx (1)
400-403: This review comment is incorrect and should be dismissed.The
listConnectedAccounts()endpoint is explicitly documented in the API to returnConnectedAccountForListobjects that exclude sensitive authorization details (OAuth tokens, API keys) for security. The endpoint's response description states: "Excludes sensitive authorization details for security." LogginglistResponsefrom this endpoint poses no credential leakage risk.If your concern applies to other endpoints—such as
getConnectedAccount()orgetOrCreateConnectedAccount()—which DO return the fullConnectedAccountobject withauthorization_details, those should be reviewed separately. The code snippet at lines 400-403 is safe as written.> Likely an incorrect or invalid review comment.
| <TabItem label="Node.js"> | ||
| ```sh showLineNumbers=false frame="none" | ||
| npm install @scalekit-sdk/node@2.2.0-beta.1 | ||
| npm install @scalekit-sdk/node |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
# Check the actual content at line 82 of the quickstart file
head -n 90 src/content/docs/agent-auth/quickstart.mdx | tail -n 20Repository: scalekit-inc/developer-docs
Length of output: 718
🏁 Script executed:
# Search for npm install patterns in Agent Auth docs to see what version is currently documented
rg "npm install.*scalekit.*node" src/content/docs/agent-auth/ -A 1 -B 1Repository: scalekit-inc/developer-docs
Length of output: 613
🏁 Script executed:
# Check if there are any references to the beta version in the file
cat src/content/docs/agent-auth/quickstart.mdx | head -n 150 | tail -n 80Repository: scalekit-inc/developer-docs
Length of output: 3141
Use the beta Node.js SDK version in the installation command.
The Node.js installation command must specify @scalekit-sdk/node@2.2.0-beta.1 because Agent Auth features are currently only available in the beta release. Other Agent Auth documentation (e.g., agent-tools-quickstart.mdx) already pins this version. Ensure consistency across all Agent Auth quickstart and guide pages.
Suggested fix
- npm install `@scalekit-sdk/node`
+ npm install `@scalekit-sdk/node`@2.2.0-beta.1🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@src/content/docs/agent-auth/quickstart.mdx` at line 82, Update the
installation command string "npm install `@scalekit-sdk/node`" to pin the beta
release by changing it to "npm install `@scalekit-sdk/node`@2.2.0-beta.1" so Agent
Auth features use the beta SDK; locate the occurrence of that exact install
command in the quickstart content and replace it to match other Agent Auth docs
(e.g., agent-tools-quickstart) for consistency.
There was a problem hiding this comment.
The agent auth is available in stable release now . We will update other places also where it mentions beta
There was a problem hiding this comment.
@dhaneshbs, thanks for the clarification! My comment was incorrect — the PR change is right to drop the beta version pin. I'll update the long-term memory to reflect this.
✏️ Learnings added
Learnt from: dhaneshbs
Repo: scalekit-inc/developer-docs PR: 514
File: src/content/docs/agent-auth/quickstart.mdx:82-82
Timestamp: 2026-03-20T02:32:39.716Z
Learning: In Agent Auth documentation under src/content/docs/agent-auth/, the Node.js SDK installation command should use the stable package `scalekit-sdk/node` (no version pin). Agent Auth features are now available in the stable release. Do not flag the removal of the `2.2.0-beta.1` beta version pin or suggest adding it back. Any remaining references to the beta version across Agent Auth docs should be updated to use the stable package.
Note: Learnings are effective only in the context of similar code segments. To apply general coding guidelines, please configure review instructions. You can manage existing learnings in the app.
⛔ Learnings removed
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:32:58.695Z
Learning: In all Agent Auth documentation under src/content/docs/agent-auth, specify that the Node.js SDK installation must be scalekit-sdk/node2.2.0-beta.1 because Agent Auth features are only available in the beta version and not in the latest stable release. Do not flag these docs as issues or suggest upgrading to stable versions.
🧠 Learnings used
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:32:58.695Z
Learning: In all Agent Auth documentation under src/content/docs/agent-auth, specify that the Node.js SDK installation must be scalekit-sdk/node2.2.0-beta.1 because Agent Auth features are only available in the beta version and not in the latest stable release. Do not flag these docs as issues or suggest upgrading to stable versions.
Learnt from: hrishikesh-p
Repo: scalekit-inc/developer-docs PR: 473
File: src/content/docs/agent-auth/tools/execute.mdx:34-76
Timestamp: 2026-03-09T15:06:49.617Z
Learning: In src/content/docs/agent-auth/tools/**/*.mdx (Agent Auth tool execution docs, e.g., execute.mdx, authorize.mdx), only Python and Node.js SDK support is currently available for Agent Auth tool execution. Do not require or enforce Go and Java tabs in Tabs syncKey="tech-stack" blocks for these files until the Go and Java SDKs support Agent Auth features. Add Go and Java TabItems once those SDKs are ready.
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-03-17T11:36:10.761Z
Learning: Applies to **/*.{md,mdx} : Use exact SDK variable names in documentation and code examples: Node.js: `scalekit`, Python: `scalekit_client`, Go: `scalekitClient`, Java: `scalekitClient`
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 455
File: src/content/docs/reference/agent-connectors/asana.mdx:94-173
Timestamp: 2026-03-03T13:35:56.400Z
Learning: For Agent Connectors documentation (src/content/docs/reference/agent-connectors/**/*.mdx), currently only Python SDK support is available for Agent Actions/Agent Connectors. Do not require or enforce the multi-language SDK code examples (Node.js, Python, Go, Java) guideline for these connector docs until SDK support is ready in other languages. The Node.js, Go, and Java examples can be added once the respective SDKs support Agent Actions features.
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .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'
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: dhaneshbs
Repo: scalekit-inc/developer-docs PR: 487
File: src/content/docs/agent-auth/connections.mdx:0-0
Timestamp: 2026-03-12T05:02:06.063Z
Learning: In Agent Auth documentation (e.g., src/content/docs/agent-auth/connections.mdx and related agent-auth docs), custom authentication flows (username/password/bearer-token) are out of scope for the current Agent Auth release. Do not flag missing or undocumented custom authentication in Agent Auth connection-type sections; reviewers should treat absence as intentional and scope-compliant rather than a gap to fix.
Learnt from: dhaneshbs
Repo: scalekit-inc/developer-docs PR: 487
File: src/content/docs/agent-auth/connections.mdx:0-0
Timestamp: 2026-03-12T05:02:06.063Z
Learning: In Agent Auth documentation (src/content/docs/agent-auth/**/), custom authentication flows (username/password/bearer-token) are out of scope for the current Agent Auth release. Do not flag the absence of custom authentication connection-type documentation in Agent Auth connection-type sections. Apply this guideline broadly to Agent Auth docs (not just this file).
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: Pranesh-Raghu
Repo: scalekit-inc/developer-docs PR: 483
File: src/components/templates/agent-connectors/_setup-onenote.mdx:12-12
Timestamp: 2026-03-12T16:29:16.422Z
Learning: In src/components/templates/agent-connectors/_setup-*.mdx files, using "Azure Active Directory" instead of the rebranded "Microsoft Entra ID" is acceptable and intentional. Do not flag "Azure Active Directory" as outdated branding in these agent-connector setup template files.
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: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 0
File: :0-0
Timestamp: 2026-03-13T04:24:59.653Z
Learning: In scalekit-inc/developer-docs, for PRs focused on tooling and templatizing (e.g., extracting usage sections into reusable MDX templates and updating sync scripts), review comments about .mdx file content quality (casing, unused imports, import consolidation, endpoint descriptions, etc.) are considered out of scope and should be resolved without blocking the PR.
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: 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.
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.
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.
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.
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.
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.
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.
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.
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.
Learnt from: dhaneshbs
Repo: scalekit-inc/developer-docs PR: 506
File: src/content/docs/authenticate/fsa/quickstart.mdx:851-853
Timestamp: 2026-03-17T16:01:50.487Z
Learning: In the Scalekit Python SDK docs, clarify that LogoutUrlOptions is not exported from the top-level scalekit package __init__.py. The correct import path in code samples or reviews is: from scalekit.common.scalekit import LogoutUrlOptions. Do not flag this import path as incorrect in documentation or code reviews; ensure examples reflect the proper import path to avoid confusion for users.
Update agent-auth quickstart to avoid logging OAuth tokens in production: add a security warning advising redaction/secure storage and wrap token console output in a NODE_ENV === 'development' check. This reduces the risk of credential leakage from logs and clarifies safe debugging practices. (src/content/docs/agent-auth/quickstart.mdx)
Update documentation to clarify Python SDK supports read-only retrieval via actions.get_connected_account (Python) / actions.getConnectedAccount (Node.js) and that actions.get_or_create_connected_account should be used for create-or-retrieve semantics. Adjust example comment to reflect the get-or-create usage and keep note that bulk list/delete operations are available in the Node.js SDK or via the API/dashboard.
There was a problem hiding this comment.
The changes look good. Line 379 now correctly distinguishes read-only retrieval ( / ) from create-or-retrieve semantics (), and the Python code example comment has been updated to accurately reflect the operation. All bulk operations reference the updated API. The original concern is fully addressed.
There was a problem hiding this comment.
The changes look good. Line 379 now correctly distinguishes read-only retrieval (actions.get_connected_account / actions.getConnectedAccount) from create-or-retrieve semantics (actions.get_or_create_connected_account), and the Python code example comment has been updated to accurately reflect the operation. All bulk operations reference the updated actions.* API. The original concern is fully addressed.
2 participants
Update Node.js examples to match the updated SDK API: replace connectedAccounts client with scalekit.actions, rename connector -> connectionName, rename getMagicLinkForConnectedAccount -> getAuthorizationLink, getConnectedAccountByIdentifier -> getConnectedAccount, and update list/delete calls to actions.*. Remove the beta-specific npm install note and use the stable @scalekit-sdk/node package, and simplify status checks to use the 'ACTIVE' string. These changes align the docs with the latest Node SDK method names and usage.
Summary by CodeRabbit