chore: clean up package.json and upgrade to astro 6#628
Merged
Conversation
…leanup - Add packageManager field to specify pnpm version - Remove husky (project uses simple-git-hooks) - Move pnpm, @types/react, @types/react-dom to devDependencies
- Add simple-git-hooks to pnpm.onlyBuiltDependencies (silences install warning) - Update packageManager field to pnpm@10.33.1 - Patch-level bumps: @astrojs/react, @iconify/json, @scalar/api-reference, @scalar/astro, @scalar/openapi-to-markdown, @tailwindcss/vite, tailwindcss, vue, netlify-cli, pnpm
- astro 5.18.1 → 6.1.9 - @astrojs/starlight 0.37.7 → 0.38.3 - @astrojs/mdx 4 → 5, @astrojs/netlify 6 → 7, @astrojs/vue 5 → 6, @astrojs/starlight-tailwind 4 → 5 - unlock all starlight plugins to latest astro-6-compatible versions - recreate vite-plugin-static-copy patch for 4.1.0 (upstream PR still open) - update PATCHES.md with new patch version
- _mcp-auth-claude-code.mdx: Import skill-activation.png and use imported variable for src (Astro 6 requires imported images) - add-modular-sso.mdx, quickstart.mdx, group-based-role-assignment.mdx: Update anchor links to account for Badge component context in heading IDs (#embed-the-admin-portal- and #generate-shareable-portal-link-)
Contributor
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
WalkthroughThis PR updates core dependencies (Astro, Starlight), refactors the LLM index generation script from synchronous to asynchronous operations with restructured output, simplifies CI/CD pipelines by removing redundant build steps, patches vite-plugin-static-copy for multi-environment builds, restructures routing and configuration, consolidates framework documentation guides, and adds OAuth/OIDC redirect rules. Changes
Estimated code review effort🎯 4 (Complex) | ⏱️ ~60 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 3
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
project-docs/PATCHES.md (1)
33-33:⚠️ Potential issue | 🟡 MinorStale version reference in "If the version changes" note.
The header and filename were updated to
@4.1.0, but this line still says the patch targets@3.4.0. Update to keep the doc internally consistent.✏️ Proposed fix
-**If the version changes before the upstream fix lands:** The patch targets `@3.4.0` specifically. If `starlight-page-actions` bumps to a newer version, `pnpm install` will warn or error. Recreate the patch: +**If the version changes before the upstream fix lands:** The patch targets `@4.1.0` specifically. If `starlight-page-actions` bumps to a newer version, `pnpm install` will warn or error. Recreate the patch:🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@project-docs/PATCHES.md` at line 33, Update the stale version reference in the sentence that reads "The patch targets `@3.4.0` specifically" to match the header/filename's `@4.1.0`; locate the string `@3.4.0` in the PATCHES.md note about "If the version changes before the upstream fix lands" and replace it with `@4.1.0` so the document is internally consistent with the `starlight-page-actions` patch version.
🤖 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/authenticate/sso/add-modular-sso.mdx`:
- Line 827: In src/content/docs/authenticate/sso/add-modular-sso.mdx update the
internal link target by removing the trailing hyphen from the anchor — change
the link that currently points to "#embed-the-admin-portal-" to
"#embed-the-admin-portal" so it matches the heading generated by the target
document (the "Embed the admin portal" heading in admin-portal.mdx); verify the
markdown link text remains unchanged and run the doc link validator to ensure
the internal link resolves.
In `@src/content/docs/directory/guides/group-based-role-assignment.mdx`:
- Line 87: The anchor fragment in the link "
/guides/admin-portal/#generate-shareable-portal-link- " has an extra trailing
hyphen; update the href in the document (the link text on line containing "Share
the [admin portal link](/guides/admin-portal/#generate-shareable-portal-link-)")
to remove the trailing hyphen so it becomes
"/guides/admin-portal/#generate-shareable-portal-link" to match the
autogenerated heading ID in admin-portal.mdx.
In `@src/content/docs/sso/quickstart.mdx`:
- Line 862: In src/content/docs/sso/quickstart.mdx update the internal link
target for the "Embedded Admin Portal guide" so it matches the actual heading
anchor: change the href fragment from "#embed-the-admin-portal-" to
"#embed-the-admin-portal" (i.e., replace
/guides/admin-portal/#embed-the-admin-portal- with
/guides/admin-portal/#embed-the-admin-portal) to fix the broken anchor.
---
Outside diff comments:
In `@project-docs/PATCHES.md`:
- Line 33: Update the stale version reference in the sentence that reads "The
patch targets `@3.4.0` specifically" to match the header/filename's `@4.1.0`;
locate the string `@3.4.0` in the PATCHES.md note about "If the version changes
before the upstream fix lands" and replace it with `@4.1.0` so the document is
internally consistent with the `starlight-page-actions` patch version.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: 2b8273bb-c3f8-473c-9003-73ab3485c430
⛔ Files ignored due to path filters (1)
pnpm-lock.yamlis excluded by!**/pnpm-lock.yaml
📒 Files selected for processing (7)
package.jsonpatches/vite-plugin-static-copy@4.1.0.patchproject-docs/PATCHES.mdsrc/components/templates/coding-agents/_mcp-auth-claude-code.mdxsrc/content/docs/authenticate/sso/add-modular-sso.mdxsrc/content/docs/directory/guides/group-based-role-assignment.mdxsrc/content/docs/sso/quickstart.mdx
📜 Review details
🧰 Additional context used
📓 Path-based instructions (7)
**/*.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/directory/guides/group-based-role-assignment.mdxsrc/content/docs/authenticate/sso/add-modular-sso.mdxsrc/components/templates/coding-agents/_mcp-auth-claude-code.mdxsrc/content/docs/sso/quickstart.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
- Journey how-to guides MUST contain numbered
<Steps>(Starlight
component). This does NOT apply tosrc/content/docs/cookbooks/**
(blog-style recipes — optional<Steps>,<Tabs>after</Steps>OK;
see cookbookspath_instructions).- 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...
Files:
src/content/docs/directory/guides/group-based-role-assignment.mdxsrc/content/docs/authenticate/sso/add-modular-sso.mdxsrc/components/templates/coding-agents/_mcp-auth-claude-code.mdxsrc/content/docs/sso/quickstart.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/directory/guides/group-based-role-assignment.mdxsrc/content/docs/authenticate/sso/add-modular-sso.mdxsrc/components/templates/coding-agents/_mcp-auth-claude-code.mdxsrc/content/docs/sso/quickstart.mdxproject-docs/PATCHES.md
**/*.{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/directory/guides/group-based-role-assignment.mdxsrc/content/docs/authenticate/sso/add-modular-sso.mdxsrc/components/templates/coding-agents/_mcp-auth-claude-code.mdxsrc/content/docs/sso/quickstart.mdxproject-docs/PATCHES.md
src/content/docs/**/*.mdx
📄 CodeRabbit inference engine (.cursor/rules/starlight-steps-tabs-structure.mdc)
src/content/docs/**/*.mdx: In MDX documentation files,<Steps>must contain one continuous ordered list. Wrap<Steps>around a normal Markdown ordered list such as1. ## ...
In MDX documentation files, numbered step lines must start at column 0. Do not indent the1. ##,2. ##, etc.
In MDX documentation files, any content that belongs to a step must be indented with 3 spaces: paragraphs, bullets, images,<Tabs>,<TabItem>, and fenced code blocks
In MDX documentation files, prefer plain Markdown inside<Steps>. If the content is mostly<Tabs>or other JSX-heavy blocks, use normal section headings instead of<Steps>
In MDX documentation files, when<Tabs>is used inside a step, keep<Tabs>,<TabItem>,</TabItem>, and</Tabs>consistently nested under that step
In MDX documentation files, if a tabs block is not part of a numbered step, place it outside</Steps>
Files:
src/content/docs/directory/guides/group-based-role-assignment.mdxsrc/content/docs/authenticate/sso/add-modular-sso.mdxsrc/content/docs/sso/quickstart.mdx
src/content/docs/**/*.{md,mdx}
📄 CodeRabbit inference engine (CLAUDE.md)
src/content/docs/**/*.{md,mdx}: Every documentation page must include frontmatter with at least:title(≤60 chars),description(≤160 chars), andsidebar.label(1-3 words)
Use H2 for major sections, H3 for subsections, and H4 only inside<Steps>; never use H1 in body content and avoid nesting beyond H4
Use numbered lists only inside<Steps>for ordered procedures; use bulleted lists for unordered information
Use bold for first mention of important terms, UI elements, and dashboard paths; use inline code for technical identifiers (variables, functions, endpoints, scopes, environment variables, file paths, placeholders)
The<Steps>component requires a single continuous ordered list with proper indentation: steps at column 0, continuation content indented with exactly 3 spaces
Use<Aside>component with atitleattribute for cautions, tips, and notes
Use<Badge>component to indicate parameter requirements in tables and inline text
Use<details>blocks at the end of pages for FAQs, common scenarios, and troubleshooting
Split content into clear sections with descriptive, sentence-style titles; include a table of contents for documents with multiple sections; keep paragraphs short and isolate critical points in their own short paragraphs
Begin sections and paragraphs with standalone topic sentences that preview content; put topic words at the beginning to support fast skimming; put key takeaways and results at the top of documents
Use bullets and tables generously to structure information; bold important text to highlight key concepts and decisions
Keep sentences simple, right-branching, and unambiguous; avoid ambiguous noun stacks and demonstrative pronouns like 'this' or 'that' when the referent is not explicit
Maintain strict consistency in terminology, formatting, and style; do not presume the reader's state of mind or intentions; use direct, instructional language
Write more simply than you think you need to; optimize for readers new to the do...
Files:
src/content/docs/directory/guides/group-based-role-assignment.mdxsrc/content/docs/authenticate/sso/add-modular-sso.mdxsrc/content/docs/sso/quickstart.mdx
src/content/docs/authenticate/**/*.mdx
⚙️ CodeRabbit configuration file
src/content/docs/authenticate/**/*.mdx: This page lives in the primary authentication section.
- If it's a quickstart or step-based guide, it MUST use
<Steps>.- Auth method pages (passwordless, social, SSO, passkeys) MUST include
a brief "when to use this" section before the implementation steps.- Any reference to tokens (idToken, accessToken, refreshToken) MUST
clarify: what it contains, its lifetime, and how to use it securely.- The FSA quickstart (
authenticate/fsa/quickstart.mdx) is the
canonical entry point — no other page should duplicate its 5-step
install→redirect→callback→session→logout structure.
Files:
src/content/docs/authenticate/sso/add-modular-sso.mdx
**/*.{js,ts,tsx,jsx,py,java,cs,go,cpp,c,rb,php,swift,kt,scala,rs,m,mm,groovy,gradle,xml,json}
📄 CodeRabbit inference engine (.cursor/rules/comment-standards.mdc)
Comments should not duplicate the code - avoid comments that simply restate what the code does; comments should add value beyond what's obvious from reading the code
Files:
package.json
🧠 Learnings (46)
📓 Common learnings
Learnt from: saravanan2003-hub
Repo: scalekit-inc/developer-docs PR: 564
File: package.json:22-28
Timestamp: 2026-04-02T09:59:43.872Z
Learning: In scalekit-inc/developer-docs, the Astro-related dependencies (astrojs/mdx, astrojs/netlify, astrojs/starlight, astrojs/starlight-tailwind, astrojs/vue) are intentionally kept on Astro 5.x.x versions (not Astro 6.x) for compatibility reasons. Do not flag these as unintentional downgrades or suggest upgrading to Astro 6.x.
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-20T11:30:52.410Z
Learning: Applies to {astro.config.mjs,src/**/*.astro} : Follow Astro + Starlight framework conventions
Learnt from: saravanan2003-hub
Repo: scalekit-inc/developer-docs PR: 564
File: package.json:6-6
Timestamp: 2026-04-02T10:00:03.444Z
Learning: In scalekit-inc/developer-docs, the `dev` script in `package.json` uses `netlify dev --skip-wait-port` to allow the browser window to boot up quickly without waiting for the port to be available. The Astro Starlight docs server then wires itself up asynchronously afterward. This avoids a race condition between Netlify CLI and Astro's dev server startup.
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-04-20T11:29:40.242Z
Learning: Follow Astro + Starlight framework conventions for documentation site development
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-20T11:30:52.410Z
Learning: Applies to {tailwind.config.mjs,src/**/*.{astro,tsx}} : Maintain compatibility with Tailwind CSS styling
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-04-20T11:29:40.242Z
Learning: Applies to {src/content/docs/guides/integrations/**/*.{md,mdx},src/components/templates/_*.{ts,tsx,astro}} : Integration guides in `src/content/docs/guides/integrations/` must be kept synchronized with their corresponding index pages and use reusable template components from `src/components/templates/`
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.
📚 Learning: 2026-01-13T12:47:52.148Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursor/rules/deno-docs-style.mdc:0-0
Timestamp: 2026-01-13T12:47:52.148Z
Learning: Applies to **/*.{md,mdx} : Use descriptive link text in documentation (e.g., 'See permission flags' not 'click here')
Applied to files:
src/content/docs/directory/guides/group-based-role-assignment.mdx
📚 Learning: 2026-04-20T11:30:52.410Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-20T11:30:52.410Z
Learning: Documentation must be organized into logical sections (FSA, SSO, Directory/SCIM, Connect, M2M, Guides, Reference) with proper sidebar configuration and navigation structure
Applied to files:
src/content/docs/directory/guides/group-based-role-assignment.mdxsrc/content/docs/authenticate/sso/add-modular-sso.mdx
📚 Learning: 2026-04-20T11:29:40.242Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-04-20T11:29:40.242Z
Learning: Applies to src/content/docs/**/*.{md,mdx} : Prefer relative links for internal pages; include anchors for sections
Applied to files:
src/content/docs/directory/guides/group-based-role-assignment.mdxsrc/content/docs/sso/quickstart.mdx
📚 Learning: 2026-01-13T12:48:11.566Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursor/rules/documentation-guide.mdc:0-0
Timestamp: 2026-01-13T12:48:11.566Z
Learning: Applies to **/*.{md,mdx} : Provide links to related concepts, guides, and references in documentation
Applied to files:
src/content/docs/directory/guides/group-based-role-assignment.mdx
📚 Learning: 2026-01-13T12:47:52.148Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursor/rules/deno-docs-style.mdc:0-0
Timestamp: 2026-01-13T12:47:52.148Z
Learning: Applies to **/*.{md,mdx} : Prefer relative links for internal documentation pages and include anchors for section references
Applied to files:
src/content/docs/directory/guides/group-based-role-assignment.mdxsrc/content/docs/sso/quickstart.mdx
📚 Learning: 2026-04-20T11:29:40.242Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-04-20T11:29:40.242Z
Learning: Applies to src/content/docs/**/*.{md,mdx} : Release notes and changelogs must be versioned and include Summary, detailed change sections (Added/Changed/Deprecated/Removed/Fixed/Security), Breaking changes, Migration guide, and Upgrade instructions
Applied to files:
src/content/docs/directory/guides/group-based-role-assignment.mdxproject-docs/PATCHES.md
📚 Learning: 2026-01-13T12:48:11.566Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursor/rules/documentation-guide.mdc:0-0
Timestamp: 2026-01-13T12:48:11.566Z
Learning: Applies to **/*.{md,mdx} : Use descriptive link text and avoid 'click here' in documentation
Applied to files:
src/content/docs/directory/guides/group-based-role-assignment.mdx
📚 Learning: 2026-04-20T14:34:06.246Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 618
File: src/content/docs/authenticate/manage-users-orgs/hosted-widgets.mdx:66-77
Timestamp: 2026-04-20T14:34:06.246Z
Learning: In `src/content/docs/authenticate/manage-users-orgs/hosted-widgets.mdx`, do not flag the absence of an explicit `state`/CSRF validation warning next to the authorization URL examples in the "Signup/login widgets" section. The page already links to `/authenticate/fsa/implement-login/` where that security guidance is covered. Flagging it here is considered out of scope for this page.
Applied to files:
src/content/docs/authenticate/sso/add-modular-sso.mdxsrc/content/docs/sso/quickstart.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/authenticate/sso/add-modular-sso.mdxsrc/content/docs/sso/quickstart.mdx
📚 Learning: 2026-03-09T07:32:44.388Z
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:44.388Z
Learning: In src/content/docs/sso/guides/sso-user-attributes.mdx and similar conceptual how-to snippets in scalekit-inc/developer-docs, when the code example's sole purpose is demonstrating how to access a specific value (e.g., reading JWT claims after token validation), omit error/non-happy-path handling to keep the snippet minimal and focused. Do not flag the absence of error paths in such narrowly scoped conceptual snippets.
Applied to files:
src/content/docs/authenticate/sso/add-modular-sso.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/authenticate/sso/add-modular-sso.mdx
📚 Learning: 2026-01-13T12:46:55.260Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursorrules:0-0
Timestamp: 2026-01-13T12:46:55.260Z
Learning: Applies to **/*.mdx : Reference images in MDX files with proper paths using `@/assets/docs/` prefix and include alt text
Applied to files:
src/components/templates/coding-agents/_mcp-auth-claude-code.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/components/templates/coding-agents/_mcp-auth-claude-code.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/components/templates/coding-agents/_mcp-auth-claude-code.mdx
📚 Learning: 2026-03-12T16:29:33.506Z
Learnt from: Pranesh-Raghu
Repo: scalekit-inc/developer-docs PR: 483
File: src/components/templates/agent-connectors/_setup-bigquery.mdx:28-28
Timestamp: 2026-03-12T16:29:33.506Z
Learning: In `src/components/templates/agent-connectors/_setup-*.mdx` files, empty alt text (`![]()`) is acceptable for ALL inline images (not just redirect URI screenshots), including API-enablement screenshots such as `enable-bigquery-api.png`. Do not flag missing alt text for any inline image in these agent-connector setup template files.
Applied to files:
src/components/templates/coding-agents/_mcp-auth-claude-code.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/components/templates/coding-agents/_mcp-auth-claude-code.mdx
📚 Learning: 2026-04-20T11:29:40.242Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-04-20T11:29:40.242Z
Learning: Applies to src/content/docs/agentkit/**/*.{md,mdx} : Agentkit code examples live in the external repo **scalekit-developers/agent-auth-examples** organized as `javascript/frameworks/<framework>` and `python/frameworks/<framework>`; verify docs snippets match current implementations in that repo
Applied to files:
src/components/templates/coding-agents/_mcp-auth-claude-code.mdx
📚 Learning: 2026-03-16T21:02:51.181Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursor/rules/expressive-code.mdc:0-0
Timestamp: 2026-03-16T21:02:51.181Z
Learning: Applies to **/*.{md,mdx} : Do not change semantics of code examples—only improve presentation and clarity when refactoring to `<Code>` components
Applied to files:
src/components/templates/coding-agents/_mcp-auth-claude-code.mdx
📚 Learning: 2026-01-13T12:48:11.566Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursor/rules/documentation-guide.mdc:0-0
Timestamp: 2026-01-13T12:48:11.566Z
Learning: Applies to **/*.{md,mdx} : Update code examples when APIs or behaviors change
Applied to files:
src/components/templates/coding-agents/_mcp-auth-claude-code.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/coding-agents/_mcp-auth-claude-code.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 collapsible sections in introduction for sequence diagrams, video demonstrations, data models, and JSON examples with appropriate icons
Applied to files:
src/components/templates/coding-agents/_mcp-auth-claude-code.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/coding-agents/_mcp-auth-claude-code.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 : Tabs components within Steps must be indented with 3 spaces, TabItem at same level as parent Tabs, code blocks properly indented within TabItem
Applied to files:
src/components/templates/coding-agents/_mcp-auth-claude-code.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/coding-agents/_mcp-auth-claude-code.mdx
📚 Learning: 2026-01-13T12:46:55.260Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursorrules:0-0
Timestamp: 2026-01-13T12:46:55.260Z
Learning: Applies to astro.config.mjs : Expressive Code collapsible sections plugin must be enabled in `astro.config.mjs`
Applied to files:
src/components/templates/coding-agents/_mcp-auth-claude-code.mdx
📚 Learning: 2026-04-20T11:30:52.410Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-20T11:30:52.410Z
Learning: Applies to {astro.config.mjs,src/**/*.astro} : Follow Astro + Starlight framework conventions
Applied to files:
src/components/templates/coding-agents/_mcp-auth-claude-code.mdxpackage.json
📚 Learning: 2026-04-20T11:30:52.410Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-20T11:30:52.410Z
Learning: Applies to **/*.{md,mdx} : Use normal section headings instead of `<Steps>` when content is mostly `<Tabs>`, long JSX blocks, or multiple embedded components
Applied to files:
src/components/templates/coding-agents/_mcp-auth-claude-code.mdx
📚 Learning: 2026-04-20T11:29:40.242Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-04-20T11:29:40.242Z
Learning: Applies to src/content/docs/**/*.{md,mdx} : The `<Steps>` component requires a single continuous ordered list with proper indentation: steps at column 0, continuation content indented with exactly 3 spaces
Applied to files:
src/components/templates/coding-agents/_mcp-auth-claude-code.mdx
📚 Learning: 2026-04-20T11:30:52.410Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-20T11:30:52.410Z
Learning: Applies to src/components/templates/_*.{ts,tsx,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/coding-agents/_mcp-auth-claude-code.mdx
📚 Learning: 2026-03-31T16:14:24.575Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: public/AGENTS.md:0-0
Timestamp: 2026-03-31T16:14:24.575Z
Learning: Use Scalekit official plugin for AI coding agents (Claude Code, GitHub Copilot, Codex, or Skills CLI/Windsurf/Cline) to reduce hallucinations and improve code generation accuracy
Applied to files:
src/components/templates/coding-agents/_mcp-auth-claude-code.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/sso/quickstart.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/sso/quickstart.mdx
📚 Learning: 2026-04-20T11:29:40.242Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-04-20T11:29:40.242Z
Learning: Before modifying patches or upgrading patched dependencies, read `project-docs/PATCHES.md` for context, removal criteria, and upgrade instructions
Applied to files:
project-docs/PATCHES.md
📚 Learning: 2026-04-02T09:59:43.872Z
Learnt from: saravanan2003-hub
Repo: scalekit-inc/developer-docs PR: 564
File: package.json:22-28
Timestamp: 2026-04-02T09:59:43.872Z
Learning: In scalekit-inc/developer-docs, the Astro-related dependencies (astrojs/mdx, astrojs/netlify, astrojs/starlight, astrojs/starlight-tailwind, astrojs/vue) are intentionally kept on Astro 5.x.x versions (not Astro 6.x) for compatibility reasons. Do not flag these as unintentional downgrades or suggest upgrading to Astro 6.x.
Applied to files:
package.json
📚 Learning: 2026-04-20T11:30:52.410Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-20T11:30:52.410Z
Learning: Applies to {tailwind.config.mjs,src/**/*.{astro,tsx}} : Maintain compatibility with Tailwind CSS styling
Applied to files:
package.json
📚 Learning: 2026-04-20T11:29:40.242Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-04-20T11:29:40.242Z
Learning: Use pnpm for package management
Applied to files:
package.json
📚 Learning: 2026-01-13T12:46:55.260Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursorrules:0-0
Timestamp: 2026-01-13T12:46:55.260Z
Learning: Applies to astro.config.mjs : Expressive Code is configured in `astro.config.mjs` with themes 'tokyo-night' (dark) and 'light-plus' (light), JetBrains Mono font, and border radius 0.375rem
Applied to files:
package.json
📚 Learning: 2026-03-31T16:14:24.575Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: public/AGENTS.md:0-0
Timestamp: 2026-03-31T16:14:24.575Z
Learning: Applies to public/**/*.{js,ts,jsx,tsx} : Node.js SDK should use the variable name `scalekit`
Applied to files:
package.json
📚 Learning: 2026-04-02T10:00:03.444Z
Learnt from: saravanan2003-hub
Repo: scalekit-inc/developer-docs PR: 564
File: package.json:6-6
Timestamp: 2026-04-02T10:00:03.444Z
Learning: In scalekit-inc/developer-docs, the `dev` script in `package.json` uses `netlify dev --skip-wait-port` to allow the browser window to boot up quickly without waiting for the port to be available. The Astro Starlight docs server then wires itself up asynchronously afterward. This avoids a race condition between Netlify CLI and Astro's dev server startup.
Applied to files:
package.json
📚 Learning: 2026-04-20T11:29:40.242Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-04-20T11:29:40.242Z
Learning: Applies to **/*.{md,mdx} : Use exact SDK variable names: Node.js: `scalekit`, Python: `scalekit_client`, Go: `scalekitClient`, Java: `scalekitClient`
Applied to files:
package.json
📚 Learning: 2026-03-25T16:04:34.150Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 532
File: astro.config.mjs:302-302
Timestamp: 2026-03-25T16:04:34.150Z
Learning: In scalekit-inc/developer-docs, the D2 diagram generation behavior (skipped when the `NETLIFY` env var is set via `netlify dev`) is already documented in CONTRIBUTING.md. Do not flag missing documentation for this behavior in `astro.config.mjs`.
Applied to files:
package.json
📚 Learning: 2026-04-20T11:30:52.410Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-20T11:30:52.410Z
Learning: Applies to **/*.{js,ts,tsx,py,go,java} : Use exact SDK variable names: Node.js: `scalekit`, Python: `scalekit_client`, Go: `scalekitClient`, Java: `scalekitClient`
Applied to files:
package.json
📚 Learning: 2026-03-20T02:32:40.836Z
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:40.836Z
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.
Applied to files:
package.json
📚 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:
package.json
📚 Learning: 2026-04-20T11:30:52.410Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-20T11:30:52.410Z
Learning: Applies to pnpm-lock.yaml : Use pnpm for package management
Applied to files:
package.json
🔇 Additional comments (3)
patches/vite-plugin-static-copy@4.1.0.patch (1)
1-14: LGTM — patch matches documented fix.The diff correctly implements the environment-aware
outDirselection described inproject-docs/PATCHES.md, targetingdist/index.jsfor v4.1.0.package.json (1)
23-66: Astro 6 upgrade intentional — superseding prior learning.A prior learning (PR
#564) stated Astro-related deps were intentionally pinned to 5.x. This PR's stated objective is the Astro 5 → 6 upgrade with matching@astrojs/*and starlight plugin bumps, so the prior learning is being deliberately superseded here. No action required; noting so reviewers relying on that learning aren't misled.src/components/templates/coding-agents/_mcp-auth-claude-code.mdx (1)
4-4: LGTM! Astro 6 image import pattern correctly applied.The changes properly implement Astro 6's requirement for imported image assets:
- Import statement follows the established
@/assets/docs/path convention- Usage matches the existing pattern on line 57 (
enableClaudePluginGif)- Descriptive alt text maintained on line 84
- Fixes build issues as documented in PR objectives
Also applies to: 83-83
✅ Deploy Preview for scalekit-starlight ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
- Remove agent-markdown-audit from default build (no-op in prod) - Replace pre-push full build with astro check (saves ~3 min per push) - Add GitHub Actions CI: type check, format check, audit on every push/PR - Enable starlightLinksValidator on deploy previews (skip production only) - Raise maxParallelFileOps from 2 to 8 to reduce Rollup serialization - Parallelize generate-llms-index.js file reads with async fs/promises - Add /_astro/* immutable cache headers for content-hashed assets - Fix incorrect node_bundler comment and remove redundant included_files - Fix stale output: server comment in astro.config.mjs - Add build audit report to project-docs/
- Extended vite-plugin-static-copy patch with two fixes: - Environment guard now defaults to 'client' when no environment option is passed - Corrected outDir resolution per environment (SSR vs client) - Re-applied astro.config.mjs maxParallelFileOps: 8 for stable builds - Reverted links validator condition to !process.env.NETLIFY for local validation - Updated pnpm-lock.yaml from patch changes - Added BUILD_AUDIT.md and BUILD_COMPARISON.md to .gitignore - Documented patch changes in project-docs/PATCHES.md
Contributor
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)
scripts/generate-llms-index.js (1)
162-165:⚠️ Potential issue | 🟠 MajorFix the root-page markdown URL.
urlPath === '/'currently turns intohttps://docs.scalekit.com.md, so the generated index emits a broken link for the home page. That’s the first page crawlers are likely to hit, so it should be special-cased.🛠️ Proposed fix
- const mdUrl = `${BASE_URL}${urlPath.replace(/\/$/, '')}.md` + const mdPath = urlPath === '/' ? '/index' : urlPath.replace(/\/$/, '') + const mdUrl = `${BASE_URL}${mdPath}.md`🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@scripts/generate-llms-index.js` around lines 162 - 165, The generated mdUrl incorrectly becomes `${BASE_URL}.md` when urlPath === '/', so special-case the root: inside the loop over pages (variables pages, urlPath, title, description) set mdUrl to `${BASE_URL}/` when urlPath === '/' otherwise build it as before (`${BASE_URL}${urlPath.replace(/\/$/, '')}.md`), then use that mdUrl when pushing the line; update the logic around the mdUrl assignment to handle the root path explicitly.project-docs/PATCHES.md (1)
45-50:⚠️ Potential issue | 🟡 MinorUpdate the stale patch-version reference.
The removal instructions still say the patch targets
@3.4.0, but this patch is now@4.1.0. That mismatch will send anyone reapplying the fix to the wrong upstream version.♻️ Suggested fix
-**If the version changes before the upstream fix lands:** The patch targets `@3.4.0` specifically. If `starlight-page-actions` bumps to a newer version, `pnpm install` will warn or error. Recreate the patch: +**If the version changes before the upstream fix lands:** The patch targets `@4.1.0` specifically. If `starlight-page-actions` bumps to a newer version, `pnpm install` will warn or error. Recreate the patch:🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@project-docs/PATCHES.md` around lines 45 - 50, Update the stale version reference in the PATCHES.md removal instructions: replace the hardcoded "@3.4.0" mention with the current patch target "@4.1.0" and ensure the example command `pnpm patch vite-plugin-static-copy@<new-version>` and the follow-up guidance (apply same one-line fix in src/build.ts or dist/index.js and run pnpm patch-commit) reflect that the patch is for `@4.1.0` so reapplying the patch will target the correct upstream version.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In @.github/workflows/ci.yml:
- Around line 22-32: CI no longer validates the production build; add an
explicit production build step and LLM index generation to the workflow by
running the equivalent of `pnpm astro build` followed by executing `node
scripts/generate-llms-index.js` (or the script that generates the LLM index)
after installation and before or alongside `pnpm astro check` and `node
scripts/agent-markdown-audit.js --strict`, so `astro build` and the
`generate-llms-index.js` path are exercised in CI and catch regressions.
---
Outside diff comments:
In `@project-docs/PATCHES.md`:
- Around line 45-50: Update the stale version reference in the PATCHES.md
removal instructions: replace the hardcoded "@3.4.0" mention with the current
patch target "@4.1.0" and ensure the example command `pnpm patch
vite-plugin-static-copy@<new-version>` and the follow-up guidance (apply same
one-line fix in src/build.ts or dist/index.js and run pnpm patch-commit) reflect
that the patch is for `@4.1.0` so reapplying the patch will target the correct
upstream version.
In `@scripts/generate-llms-index.js`:
- Around line 162-165: The generated mdUrl incorrectly becomes `${BASE_URL}.md`
when urlPath === '/', so special-case the root: inside the loop over pages
(variables pages, urlPath, title, description) set mdUrl to `${BASE_URL}/` when
urlPath === '/' otherwise build it as before
(`${BASE_URL}${urlPath.replace(/\/$/, '')}.md`), then use that mdUrl when
pushing the line; update the logic around the mdUrl assignment to handle the
root path explicitly.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: bfe72662-686e-45e1-bfb8-6c7ba4666e4f
⛔ Files ignored due to path filters (1)
pnpm-lock.yamlis excluded by!**/pnpm-lock.yaml
📒 Files selected for processing (9)
.github/workflows/ci.yml.gitignore.simple-git-hooks.jsonastro.config.mjsnetlify.tomlpackage.jsonpatches/vite-plugin-static-copy@4.1.0.patchproject-docs/PATCHES.mdscripts/generate-llms-index.js
📜 Review details
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: Redirect rules - scalekit-starlight
- GitHub Check: Header rules - scalekit-starlight
- GitHub Check: Pages changed - scalekit-starlight
🧰 Additional context used
📓 Path-based instructions (9)
**/*.{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:
project-docs/PATCHES.md
**/*.{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:
project-docs/PATCHES.md
**/*.{js,ts,tsx,jsx,py,java,cs,go,cpp,c,rb,php,swift,kt,scala,rs,m,mm,groovy,gradle,xml,json}
📄 CodeRabbit inference engine (.cursor/rules/comment-standards.mdc)
Comments should not duplicate the code - avoid comments that simply restate what the code does; comments should add value beyond what's obvious from reading the code
Files:
scripts/generate-llms-index.jspackage.json
**/*.{js,ts,tsx,jsx,py,java,cs,go,cpp,c,rb,php,swift,kt,scala,rs,m,mm,groovy}
📄 CodeRabbit inference engine (.cursor/rules/comment-standards.mdc)
**/*.{js,ts,tsx,jsx,py,java,cs,go,cpp,c,rb,php,swift,kt,scala,rs,m,mm,groovy}: Good comments do not excuse unclear code - refactor the code to be self-explanatory instead of using comments to explain poorly written code; use better variable names, function names, and code structure
Comments should dispel confusion, not cause it - ensure comments clarify rather than obscure the code's purpose; avoid cryptic or joke comments
Explain unidiomatic code in comments - comment on code that might seem unnecessary or redundant and document why you chose a specific pattern over more common alternatives, especially when it deviates from team conventions
Provide links to the original source of copied code - always attribute code copied from external sources with URLs to Stack Overflow answers, GitHub repositories, or documentation
Include links to external references where helpful - reference standards, RFCs, and official documentation; link to relevant specifications when implementing protocols
Add comments when fixing bugs - document bug fixes with context about the issue, reference issue trackers and bug reports, and explain workarounds and their limitations
Use comments to mark incomplete implementations - use standard formats for TODO, FIXME, and NOTE comments with context about what needs to be done and reference issue trackers when possible
Always document public APIs with function/class comments - explain the purpose, parameters, return values, and exceptions; include usage examples for complex functions
Include file headers with copyright information, license, and authorship - provide a brief description of the file's purpose and document dependencies and requirements
Files:
scripts/generate-llms-index.js
**/*.{js,ts,tsx,jsx}
📄 CodeRabbit inference engine (.cursor/rules/comment-standards.mdc)
Use JSDoc standards for all function, class, and complex logic comments in JavaScript/TypeScript - include parameter descriptions (
@param), return values (@returns), types (@type), and descriptions; document exceptions and edge cases
Files:
scripts/generate-llms-index.js
**/*.{js,ts,tsx,py,go,java}
📄 CodeRabbit inference engine (AGENTS.md)
Use exact SDK variable names: Node.js:
scalekit, Python:scalekit_client, Go:scalekitClient, Java:scalekitClient
Files:
scripts/generate-llms-index.js
**/*.{ts,js,mjs}
⚙️ CodeRabbit configuration file
**/*.{ts,js,mjs}: Do NOT enforce code-commenting style rules on these files.
Specifically, do not flag:
- Comments that "duplicate" or restate what the code does.
- Missing comments on bug fixes, workarounds, or issue references.
- Missing inline documentation or explanatory comments.
Code comments are at the author's discretion.
Files:
scripts/generate-llms-index.jsastro.config.mjs
astro.config.mjs
📄 CodeRabbit inference engine (.cursorrules)
astro.config.mjs: Expressive Code is configured inastro.config.mjswith themes 'tokyo-night' (dark) and 'light-plus' (light), JetBrains Mono font, and border radius 0.375rem
Expressive Code collapsible sections plugin must be enabled inastro.config.mjs
Files:
astro.config.mjs
⚙️ CodeRabbit configuration file
astro.config.mjs: - Sidebar config is imported fromsrc/configs/sidebar.config.ts—
do NOT inline sidebar items here directly.
- Any new Starlight plugin added must be documented in a comment
explaining its purpose.starlightLinksValidatorexclude patterns must stay minimal —
only exclude paths that genuinely can't be validated (e.g.,/apis/**).
Files:
astro.config.mjs
{astro.config.mjs,src/**/*.astro}
📄 CodeRabbit inference engine (AGENTS.md)
Follow Astro + Starlight framework conventions
Files:
astro.config.mjs
🧠 Learnings (20)
📓 Common learnings
Learnt from: saravanan2003-hub
Repo: scalekit-inc/developer-docs PR: 564
File: package.json:22-28
Timestamp: 2026-04-02T09:59:43.872Z
Learning: In scalekit-inc/developer-docs, the Astro-related dependencies (astrojs/mdx, astrojs/netlify, astrojs/starlight, astrojs/starlight-tailwind, astrojs/vue) are intentionally kept on Astro 5.x.x versions (not Astro 6.x) for compatibility reasons. Do not flag these as unintentional downgrades or suggest upgrading to Astro 6.x.
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-20T11:30:52.410Z
Learning: Applies to {astro.config.mjs,src/**/*.astro} : Follow Astro + Starlight framework conventions
Learnt from: saravanan2003-hub
Repo: scalekit-inc/developer-docs PR: 564
File: package.json:6-6
Timestamp: 2026-04-02T10:00:03.444Z
Learning: In scalekit-inc/developer-docs, the `dev` script in `package.json` uses `netlify dev --skip-wait-port` to allow the browser window to boot up quickly without waiting for the port to be available. The Astro Starlight docs server then wires itself up asynchronously afterward. This avoids a race condition between Netlify CLI and Astro's dev server startup.
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursor/rules/documentation-guide.mdc:0-0
Timestamp: 2026-01-13T12:48:11.566Z
Learning: Applies to **/*.{md,mdx} : Update broken links immediately in documentation
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursorrules:0-0
Timestamp: 2026-01-13T12:46:55.260Z
Learning: Run prettier with `prettier --write src/content/docs/**/*.mdx` to auto-fix MDX Steps indentation errors
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-20T11:30:52.410Z
Learning: Applies to {tailwind.config.mjs,src/**/*.{astro,tsx}} : Maintain compatibility with Tailwind CSS styling
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursor/rules/documentation-guide.mdc:0-0
Timestamp: 2026-01-13T12:48:11.566Z
Learning: Applies to **/*.{md,mdx} : Update code examples when APIs or behaviors change
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-04-20T11:29:40.242Z
Learning: All changes must pass format checking with Prettier, build process without errors, Git hook validations, and content structure validation
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-04-20T11:29:40.242Z
Learning: Applies to src/content/docs/**/*.{md,mdx} : Prefer relative links for internal pages; include anchors for sections
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-20T11:30:52.410Z
Learning: Applies to **/*.{md,mdx} : Proactively address common setup and configuration problems
📚 Learning: 2026-01-13T12:48:11.566Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursor/rules/documentation-guide.mdc:0-0
Timestamp: 2026-01-13T12:48:11.566Z
Learning: Applies to **/*.{md,mdx} : Keep documentation synchronized with product changes
Applied to files:
.gitignorescripts/generate-llms-index.js
📚 Learning: 2026-04-20T11:30:52.410Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-20T11:30:52.410Z
Learning: Applies to **/*.{md,mdx} : Documentation must pass the build process without errors
Applied to files:
.gitignore
📚 Learning: 2026-04-20T11:29:40.242Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-04-20T11:29:40.242Z
Learning: All changes must pass format checking with Prettier, build process without errors, Git hook validations, and content structure validation
Applied to files:
.simple-git-hooks.json.github/workflows/ci.yml
📚 Learning: 2026-04-20T11:30:52.410Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-20T11:30:52.410Z
Learning: Applies to **/*.{md,mdx} : Documentation must pass Git hook validations
Applied to files:
.simple-git-hooks.json
📚 Learning: 2026-04-20T11:29:40.242Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-04-20T11:29:40.242Z
Learning: Before modifying patches or upgrading patched dependencies, read `project-docs/PATCHES.md` for context, removal criteria, and upgrade instructions
Applied to files:
project-docs/PATCHES.md
📚 Learning: 2026-03-25T16:04:34.150Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 532
File: astro.config.mjs:302-302
Timestamp: 2026-03-25T16:04:34.150Z
Learning: In scalekit-inc/developer-docs, the D2 diagram generation behavior (skipped when the `NETLIFY` env var is set via `netlify dev`) is already documented in CONTRIBUTING.md. Do not flag missing documentation for this behavior in `astro.config.mjs`.
Applied to files:
netlify.tomlastro.config.mjspackage.json
📚 Learning: 2026-04-02T10:00:03.444Z
Learnt from: saravanan2003-hub
Repo: scalekit-inc/developer-docs PR: 564
File: package.json:6-6
Timestamp: 2026-04-02T10:00:03.444Z
Learning: In scalekit-inc/developer-docs, the `dev` script in `package.json` uses `netlify dev --skip-wait-port` to allow the browser window to boot up quickly without waiting for the port to be available. The Astro Starlight docs server then wires itself up asynchronously afterward. This avoids a race condition between Netlify CLI and Astro's dev server startup.
Applied to files:
netlify.tomlastro.config.mjspackage.json
📚 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:
astro.config.mjs
📚 Learning: 2026-01-13T12:46:55.260Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursorrules:0-0
Timestamp: 2026-01-13T12:46:55.260Z
Learning: Applies to astro.config.mjs : Expressive Code is configured in `astro.config.mjs` with themes 'tokyo-night' (dark) and 'light-plus' (light), JetBrains Mono font, and border radius 0.375rem
Applied to files:
astro.config.mjs
📚 Learning: 2026-04-02T09:59:43.872Z
Learnt from: saravanan2003-hub
Repo: scalekit-inc/developer-docs PR: 564
File: package.json:22-28
Timestamp: 2026-04-02T09:59:43.872Z
Learning: In scalekit-inc/developer-docs, the Astro-related dependencies (astrojs/mdx, astrojs/netlify, astrojs/starlight, astrojs/starlight-tailwind, astrojs/vue) are intentionally kept on Astro 5.x.x versions (not Astro 6.x) for compatibility reasons. Do not flag these as unintentional downgrades or suggest upgrading to Astro 6.x.
Applied to files:
package.json
📚 Learning: 2026-03-20T02:32:40.836Z
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:40.836Z
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.
Applied to files:
package.json
📚 Learning: 2026-04-20T11:29:40.242Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-04-20T11:29:40.242Z
Learning: Use pnpm for package management
Applied to files:
package.json
📚 Learning: 2026-04-23T08:31:50.417Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 627
File: src/content/docs/cookbooks/render-github-pr-summarizer.mdx:91-92
Timestamp: 2026-04-23T08:31:50.417Z
Learning: In `src/content/docs/cookbooks/render-github-pr-summarizer.mdx`, the `npm install` instructions for `express` and `types/express` intentionally omit version pinning. The express types usage in this cookbook is minimal, and the author considers version incompatibility risk low enough to not warrant pinning guidance. Do not flag missing version constraints for these packages in future reviews of this file.
Applied to files:
package.json
📚 Learning: 2026-03-31T16:14:24.575Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: public/AGENTS.md:0-0
Timestamp: 2026-03-31T16:14:24.575Z
Learning: Applies to public/**/*.{js,ts,jsx,tsx} : Node.js SDK should use the variable name `scalekit`
Applied to files:
package.json
📚 Learning: 2026-04-20T11:29:40.242Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-04-20T11:29:40.242Z
Learning: Applies to **/*.{md,mdx} : Use exact SDK variable names: Node.js: `scalekit`, Python: `scalekit_client`, Go: `scalekitClient`, Java: `scalekitClient`
Applied to files:
package.json
📚 Learning: 2026-04-20T11:30:52.410Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-20T11:30:52.410Z
Learning: Applies to **/*.{js,ts,tsx,py,go,java} : Use exact SDK variable names: Node.js: `scalekit`, Python: `scalekit_client`, Go: `scalekitClient`, Java: `scalekitClient`
Applied to files:
package.json
📚 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:
package.json
📚 Learning: 2026-04-20T11:30:52.410Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-20T11:30:52.410Z
Learning: Applies to pnpm-lock.yaml : Use pnpm for package management
Applied to files:
package.json
📚 Learning: 2026-04-20T11:30:52.410Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-20T11:30:52.410Z
Learning: Applies to {tailwind.config.mjs,src/**/*.{astro,tsx}} : Maintain compatibility with Tailwind CSS styling
Applied to files:
package.json
🪛 markdownlint-cli2 (0.22.1)
project-docs/PATCHES.md
[warning] 25-25: Ordered list item prefix
Expected: 1; Actual: 2; Style: 1/1/1
(MD029, ol-prefix)
🔇 Additional comments (2)
.gitignore (1)
57-58: Ignore rules look correct for generated build-audit artifacts.These entries are aligned with the PR’s audit-report workflow and help keep generated docs out of version control noise.
patches/vite-plugin-static-copy@4.1.0.patch (1)
7-20: Patch logic looks correct.The
clientfallback and env-specificoutDirboth address the multi-environment overwrite bug without changing the copy flow.
…ucts - Add framework routing table to llms.txt header so agents can fetch framework pages directly without loading the full AgentKit set (6.7x token savings) - Add AgentKit Frameworks custom set (98KB vs 540KB full set) covering overview, quickstart, frameworks/**, examples/**, sdks/** - Reorganize llms.txt from flat 200-page dump into 23 named sections (AgentKit split into 10 sub-sections, connectors last) - Add cookbooks/** to AgentKit set and promote framework/example/cookbook paths - Demote agentkit/connectors/** (100+ entries) to reduce noise in general queries - Fix Astro 6 content layer compatibility: remove .mdx extensions from all explicit paths in customSets, promote, demote, exclude — Astro 6 strips extensions from doc.id so patterns like **/quickstart.mdx never matched, leaving quickstart-collection.txt empty (116B → 166KB) Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- generate-llms-index.js: extend parseFrontmatter to detect sidebar.hidden and skip those pages from llms.txt index (404 and sso-migration-strategy were leaking) - llms.config.ts: add 404 and guides/sso/sso-migration-strategy to exclude list so they are dropped from llms-small.txt and custom sets - llms.config.ts: remove guides/sso/** from enterprise-sso set paths (that dir contains only the hidden migration page) Note: llms-full.txt intentionally includes all published pages by plugin design — no exclude mechanism is exposed for that file. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Pre-filled with current Version B (dist/llms.txt) for direct use without manual copy-paste. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Introduce MCP connectors as a second type of custom provider alongside REST API providers. Add MCP JSON payload examples for all 4 auth types (OAuth, Bearer, Basic, API Key), document list_scoped_tools and execute_tool for MCP tool calling, and update framing across all pages to cover both REST and MCP modes.
Renamed pages for clarity, merged auth-types-and-patterns with managing-connectors content to eliminate duplication, improved wording and navigation throughout. Updated redirects and sidebar configuration.
…to connector docs
…les/ frameworks/ directory was deleted — all 9 framework routing URLs were pointing to 404s. Updated to agentkit/examples/ (7 pages: LangChain, Vercel AI, Anthropic, OpenAI, Google ADK, Mastra, Claude Managed Agents). Removed google-genai, agno, mcp from framework routing (no examples pages for those). Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Actionable comments posted: 12
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In @.github/workflows/ci.yml:
- Around line 1-10: The workflow currently uses a broad push trigger and a
pull_request trigger which will run the same commit twice (see the top-level on:
push: branches: ['**'] and pull_request), and it lacks concurrency and explicit
permissions; update the workflow to scope or remove the push trigger (only
protect branches or drop push) so PRs don’t double-run, add a concurrency group
(e.g., keyed on github.ref or github.workflow) to the check job to cancel
in-flight runs for the same branch, and add a top-level permissions: contents:
read to limit access for the read-only check job; target the top-level on:, the
job named check, and add concurrency and permissions keys accordingly.
In @.simple-git-hooks.json:
- Line 3: Pre-push hook removed the build gate; restore a build-based check by
updating the "pre-push" entry in .simple-git-hooks.json to run the local build
(e.g., "pnpm run build" or "pnpm astro build") and the search-index generation
("pnpm run generate-search-index") before the existing checks so that the hook
runs the build step(s) prior to running node scripts/log-preview-url.js;
reference the "pre-push" hook key in .simple-git-hooks.json and ensure the
command exits non‑zero on failure so the push is blocked.
In `@llms-judge-prompt.txt`:
- Line 75: Update the embedded VERSION_B string that contains the broken docs
link: replace the invalid "https://docs.scalekit.com.md" with the correct
documentation URL (for example "https://docs.scalekit.com" or the canonical docs
host) inside the VERSION_B text so link resolution succeeds; locate the
VERSION_B constant or block in the llms-judge-prompt content and edit the URL
only, preserving the surrounding markdown and text.
- Around line 141-145: The embedded VERSION_B block contains outdated BYOC
routes; update each link in the VERSION_B content to the canonical (post-rename)
BYOC pages so evaluation payloads use current paths—locate the VERSION_B block
in llms-judge-prompt.txt and replace the four links (Auth patterns, Managing
connectors, Bring your own connector, Use Tool Proxy) with their corresponding
canonical URLs on docs.scalekit.com (ensure the link text stays the same but the
hrefs point to the renamed/official routes).
In `@package.json`:
- Line 5: The package.json currently pins pnpm twice: via the "packageManager"
field and again under devDependencies as "pnpm": "^10.33.1"; remove the pnpm
entry from devDependencies so the project only relies on the "packageManager":
"pnpm@10.33.1" pin. Locate the devDependencies object (search for the "pnpm" key
or the literal "^10.33.1" value) and delete that dependency entry, leaving other
devDependencies untouched, then run your package manager's install/lock update
to confirm no pnpm entry remains in the lockfile or dependency graph.
In `@scripts/generate-llms-index.js`:
- Around line 186-190: The "MCP Authentication" matcher includes a dead disjunct
p.startsWith('/agentkit/mcp/') because AGENTKIT_SECTIONS (specifically the
"AgentKit — MCP Integration" entry) already claims those paths via the assigned
Set; update the matcher in the MCP Authentication object to remove the
p.startsWith('/agentkit/mcp/') branch so the match logic only tests
'/authenticate/mcp/' and '/mcp/' (leave AGENTKIT_SECTIONS and the assigned Set
logic unchanged), ensuring the matcher is not misleading for future editors.
- Around line 92-102: The walk generator currently calls stat for every entry;
change it to call readdir(dir, { withFileTypes: true }) and iterate Dirent
objects, using dirent.isDirectory() to recurse with yield* walk(join(dir,
dirent.name)) and dirent.isFile() (or opposite logic) to compute ext =
extname(dirent.name) and yield the full path for .md/.mdx files; remove the
now-unused stat import and keep using join and extname as in the original walk
function.
In `@src/content/docs/agentkit/bring-your-own-connector/create-connector.mdx`:
- Around line 360-366: The curl example is using single quotes around
'$SCALEKIT_ENVIRONMENT_URL', '$SCALEKIT_CLIENT_ID', and
'$SCALEKIT_CLIENT_SECRET' which prevents shell variable expansion; update the
curl snippet so the URL and the client_id and client_secret arguments use double
quotes (allowing $SCALEKIT_ENVIRONMENT_URL, $SCALEKIT_CLIENT_ID, and
$SCALEKIT_CLIENT_SECRET to expand), while leaving the Content-Type and
grant_type lines quoted as-is since they contain no variables.
- Line 4: Update the frontmatter tags in create-connector.mdx to use the primary
product tag "agentkit" for consistency: replace the current tags array (tags:
[agentauth, connectors, auth, oauth2, proxy, guide]) with one matching the
sibling overview page (e.g., tags: [agentkit, connectors, customconnectors,
guide]) so tag-based navigation/search remains consistent; modify the 'tags'
frontmatter line in create-connector.mdx accordingly.
- Around line 156-186: The Freshdesk BASIC auth example is missing the required
password field; update the auth_patterns entry where type is "BASIC" by adding a
password field object to the "fields" array immediately after the existing
"username" entry (keep the "field_name": "password", "label": "Password",
"input_type": "password", appropriate "hint" and "required": true) so the BASIC
auth collects both username and password as described.
In `@src/content/docs/agentkit/bring-your-own-connector/overview.mdx`:
- Line 41: Update step 4 in overview.mdx to remove the circular phrasing "Make
tool calls using Tool Proxy for REST API connectors, or tool calling for MCP
connectors"; replace it with a clear distinction such as "Invoke tools via Tool
Proxy for REST API connectors, or invoke tools directly for MCP connectors"
(locate the line containing the original step 4 text and the phrase "Tool Proxy"
/ "MCP connectors" to apply the change).
In `@src/content/docs/agentkit/tools/scalekit-optimized-tools.mdx`:
- Around line 59-102: Update the Python example to use only the supported
execute_tool parameters: remove the invalid connection_name argument and either
supply identifier alone (to select the user's default connection) or supply
connected_account_id to target a specific connected account; reference the
execute_tool call in the docs and ensure it only passes tool_name, tool_input,
identifier (or connected_account_id) consistent with the Python SDK signature.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: 39a16b85-9951-4b0e-8a45-e95de2e0319a
⛔ Files ignored due to path filters (1)
pnpm-lock.yamlis excluded by!**/pnpm-lock.yaml
📒 Files selected for processing (21)
.github/workflows/ci.yml.prettierignore.simple-git-hooks.jsonllms-judge-prompt.txtpackage.jsonscripts/generate-llms-index.jssrc/configs/llms.config.tssrc/configs/redirects.config.tssrc/configs/sidebar.config.tssrc/content/docs/agentkit/advanced/custom-domain.mdxsrc/content/docs/agentkit/advanced/launch-checklist.mdxsrc/content/docs/agentkit/bring-your-own-connector/auth-types-and-patterns.mdxsrc/content/docs/agentkit/bring-your-own-connector/create-connector.mdxsrc/content/docs/agentkit/bring-your-own-connector/making-tool-calls.mdxsrc/content/docs/agentkit/bring-your-own-connector/managing-connectors.mdxsrc/content/docs/agentkit/bring-your-own-connector/overview.mdxsrc/content/docs/agentkit/bring-your-own-connector/using-tool-proxy.mdxsrc/content/docs/agentkit/connectors/index.mdxsrc/content/docs/agentkit/tools/scalekit-optimized-tools.mdxsrc/content/docs/reference/agent-connectors/box.mdxsrc/data/agent-connectors/box.ts
💤 Files with no reviewable changes (3)
- src/content/docs/agentkit/bring-your-own-connector/auth-types-and-patterns.mdx
- src/content/docs/agentkit/bring-your-own-connector/using-tool-proxy.mdx
- src/content/docs/agentkit/bring-your-own-connector/managing-connectors.mdx
Contributor
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@package.json`:
- Line 85: The package bump to "typescript": "^6.0.3" can change several
compiler defaults and break the build/astro check; update the project's
tsconfig.json (which extends "astro/tsconfigs/strict") to explicitly pin the
compiler options that changed in TS 6 so behavior stays consistent: add explicit
settings for "strict", "module", "target", "noUncheckedSideEffectImports", "lib"
(or "libReplacement"/equivalent), "rootDir", and "moduleResolution" to the
values you expect from TS 5.x (rather than relying on new TS6 defaults), then
run the full build and "astro check" to verify no regressions and adjust values
if needed.
In `@scripts/generate-llms-index.js`:
- Around line 34-38: The `CUSTOM_SETS` entry's desc for "AgentKit Frameworks"
lists wrong frameworks (says "Agno, MCP") while the actual set covers Claude
Managed Agents; update the desc string in scripts/generate-llms-index.js's
CUSTOM_SETS entry to accurately name "Claude Managed Agents" (or the exact
frameworks listed in llms.config.ts), and refactor to avoid duplication by
exporting a single AGENTKIT_FRAMEWORKS constant (e.g., array of { name, slug })
from llms.config.ts and using/importing that constant in both the routing blocks
and the scripts/generate-llms-index.js CUSTOM_SETS entry so the description and
routes stay in sync.
- Around line 118-120: The mdUrl function produces a broken homepage URL; update
mdUrl to special-case the root path: if urlPath === '/' return
`${BASE_URL}index.html.md`, otherwise keep the existing behavior of trimming a
trailing slash from urlPath (urlPath.replace(/\/$/, '')) and appending '.md'.
Make this change inside the mdUrl function so other paths remain unchanged and
the homepage maps to index.html.md.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: 4b446416-427f-413e-8189-ac457a954325
⛔ Files ignored due to path filters (1)
public/d2/docs/cookbooks/render-github-pr-summarizer-0.svgis excluded by!**/*.svg
📒 Files selected for processing (12)
package.jsonscripts/generate-llms-index.jssrc/configs/llms.config.tssrc/content/docs/agentkit/frameworks/agno.mdxsrc/content/docs/agentkit/frameworks/anthropic.mdxsrc/content/docs/agentkit/frameworks/google-adk.mdxsrc/content/docs/agentkit/frameworks/google-genai.mdxsrc/content/docs/agentkit/frameworks/langchain.mdxsrc/content/docs/agentkit/frameworks/mastra.mdxsrc/content/docs/agentkit/frameworks/mcp.mdxsrc/content/docs/agentkit/frameworks/openai.mdxsrc/content/docs/agentkit/frameworks/vercel-ai.mdx
💤 Files with no reviewable changes (9)
- src/content/docs/agentkit/frameworks/mastra.mdx
- src/content/docs/agentkit/frameworks/mcp.mdx
- src/content/docs/agentkit/frameworks/vercel-ai.mdx
- src/content/docs/agentkit/frameworks/google-genai.mdx
- src/content/docs/agentkit/frameworks/openai.mdx
- src/content/docs/agentkit/frameworks/agno.mdx
- src/content/docs/agentkit/frameworks/anthropic.mdx
- src/content/docs/agentkit/frameworks/langchain.mdx
- src/content/docs/agentkit/frameworks/google-adk.mdx
📜 Review details
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: Redirect rules - scalekit-starlight
- GitHub Check: Header rules - scalekit-starlight
- GitHub Check: Pages changed - scalekit-starlight
🧰 Additional context used
📓 Path-based instructions (5)
**/*.{js,ts,tsx,jsx,py,java,cs,go,cpp,c,rb,php,swift,kt,scala,rs,m,mm,groovy,gradle,xml,json}
📄 CodeRabbit inference engine (.cursor/rules/comment-standards.mdc)
Comments should not duplicate the code - avoid comments that simply restate what the code does; comments should add value beyond what's obvious from reading the code
Files:
package.jsonscripts/generate-llms-index.jssrc/configs/llms.config.ts
**/*.{js,ts,tsx,jsx,py,java,cs,go,cpp,c,rb,php,swift,kt,scala,rs,m,mm,groovy}
📄 CodeRabbit inference engine (.cursor/rules/comment-standards.mdc)
**/*.{js,ts,tsx,jsx,py,java,cs,go,cpp,c,rb,php,swift,kt,scala,rs,m,mm,groovy}: Good comments do not excuse unclear code - refactor the code to be self-explanatory instead of using comments to explain poorly written code; use better variable names, function names, and code structure
Comments should dispel confusion, not cause it - ensure comments clarify rather than obscure the code's purpose; avoid cryptic or joke comments
Explain unidiomatic code in comments - comment on code that might seem unnecessary or redundant and document why you chose a specific pattern over more common alternatives, especially when it deviates from team conventions
Provide links to the original source of copied code - always attribute code copied from external sources with URLs to Stack Overflow answers, GitHub repositories, or documentation
Include links to external references where helpful - reference standards, RFCs, and official documentation; link to relevant specifications when implementing protocols
Add comments when fixing bugs - document bug fixes with context about the issue, reference issue trackers and bug reports, and explain workarounds and their limitations
Use comments to mark incomplete implementations - use standard formats for TODO, FIXME, and NOTE comments with context about what needs to be done and reference issue trackers when possible
Always document public APIs with function/class comments - explain the purpose, parameters, return values, and exceptions; include usage examples for complex functions
Include file headers with copyright information, license, and authorship - provide a brief description of the file's purpose and document dependencies and requirements
Files:
scripts/generate-llms-index.jssrc/configs/llms.config.ts
**/*.{js,ts,tsx,jsx}
📄 CodeRabbit inference engine (.cursor/rules/comment-standards.mdc)
Use JSDoc standards for all function, class, and complex logic comments in JavaScript/TypeScript - include parameter descriptions (
@param), return values (@returns), types (@type), and descriptions; document exceptions and edge cases
Files:
scripts/generate-llms-index.jssrc/configs/llms.config.ts
**/*.{js,ts,tsx,py,go,java}
📄 CodeRabbit inference engine (AGENTS.md)
Use exact SDK variable names: Node.js:
scalekit, Python:scalekit_client, Go:scalekitClient, Java:scalekitClient
Files:
scripts/generate-llms-index.jssrc/configs/llms.config.ts
**/*.{ts,js,mjs}
⚙️ CodeRabbit configuration file
**/*.{ts,js,mjs}: Do NOT enforce code-commenting style rules on these files.
Specifically, do not flag:
- Comments that "duplicate" or restate what the code does.
- Missing comments on bug fixes, workarounds, or issue references.
- Missing inline documentation or explanatory comments.
Code comments are at the author's discretion.
Files:
scripts/generate-llms-index.jssrc/configs/llms.config.ts
🧠 Learnings (75)
📓 Common learnings
Learnt from: saravanan2003-hub
Repo: scalekit-inc/developer-docs PR: 564
File: package.json:22-28
Timestamp: 2026-04-02T09:59:43.872Z
Learning: In scalekit-inc/developer-docs, the Astro-related dependencies (astrojs/mdx, astrojs/netlify, astrojs/starlight, astrojs/starlight-tailwind, astrojs/vue) are intentionally kept on Astro 5.x.x versions (not Astro 6.x) for compatibility reasons. Do not flag these as unintentional downgrades or suggest upgrading to Astro 6.x.
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-20T11:30:52.410Z
Learning: Applies to {astro.config.mjs,src/**/*.astro} : Follow Astro + Starlight framework conventions
Learnt from: saravanan2003-hub
Repo: scalekit-inc/developer-docs PR: 564
File: package.json:6-6
Timestamp: 2026-04-02T10:00:03.444Z
Learning: In scalekit-inc/developer-docs, the `dev` script in `package.json` uses `netlify dev --skip-wait-port` to allow the browser window to boot up quickly without waiting for the port to be available. The Astro Starlight docs server then wires itself up asynchronously afterward. This avoids a race condition between Netlify CLI and Astro's dev server startup.
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:40.836Z
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.
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-20T11:30:52.410Z
Learning: Applies to {tailwind.config.mjs,src/**/*.{astro,tsx}} : Maintain compatibility with Tailwind CSS styling
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursorrules:0-0
Timestamp: 2026-01-13T12:46:55.260Z
Learning: Applies to astro.config.mjs : Expressive Code is configured in `astro.config.mjs` with themes 'tokyo-night' (dark) and 'light-plus' (light), JetBrains Mono font, and border radius 0.375rem
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-04-20T11:29:40.242Z
Learning: Follow Astro + Starlight framework conventions for documentation site development
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 532
File: astro.config.mjs:302-302
Timestamp: 2026-03-25T16:04:34.150Z
Learning: In scalekit-inc/developer-docs, the D2 diagram generation behavior (skipped when the `NETLIFY` env var is set via `netlify dev`) is already documented in CONTRIBUTING.md. Do not flag missing documentation for this behavior in `astro.config.mjs`.
📚 Learning: 2026-04-02T09:59:43.872Z
Learnt from: saravanan2003-hub
Repo: scalekit-inc/developer-docs PR: 564
File: package.json:22-28
Timestamp: 2026-04-02T09:59:43.872Z
Learning: In scalekit-inc/developer-docs, the Astro-related dependencies (astrojs/mdx, astrojs/netlify, astrojs/starlight, astrojs/starlight-tailwind, astrojs/vue) are intentionally kept on Astro 5.x.x versions (not Astro 6.x) for compatibility reasons. Do not flag these as unintentional downgrades or suggest upgrading to Astro 6.x.
Applied to files:
package.json
📚 Learning: 2026-03-20T02:32:40.836Z
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:40.836Z
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.
Applied to files:
package.jsonsrc/configs/llms.config.ts
📚 Learning: 2026-04-20T11:30:52.410Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-20T11:30:52.410Z
Learning: Applies to {astro.config.mjs,src/**/*.astro} : Follow Astro + Starlight framework conventions
Applied to files:
package.jsonscripts/generate-llms-index.js
📚 Learning: 2026-04-20T11:30:52.410Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-20T11:30:52.410Z
Learning: Applies to {tailwind.config.mjs,src/**/*.{astro,tsx}} : Maintain compatibility with Tailwind CSS styling
Applied to files:
package.json
📚 Learning: 2026-04-23T08:31:50.417Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 627
File: src/content/docs/cookbooks/render-github-pr-summarizer.mdx:91-92
Timestamp: 2026-04-23T08:31:50.417Z
Learning: In `src/content/docs/cookbooks/render-github-pr-summarizer.mdx`, the `npm install` instructions for `express` and `types/express` intentionally omit version pinning. The express types usage in this cookbook is minimal, and the author considers version incompatibility risk low enough to not warrant pinning guidance. Do not flag missing version constraints for these packages in future reviews of this file.
Applied to files:
package.json
📚 Learning: 2026-04-20T11:30:52.410Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-20T11:30:52.410Z
Learning: Applies to pnpm-lock.yaml : Use pnpm for package management
Applied to files:
package.json
📚 Learning: 2026-04-20T11:29:40.242Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-04-20T11:29:40.242Z
Learning: Use pnpm for package management
Applied to files:
package.json
📚 Learning: 2026-04-02T10:00:03.444Z
Learnt from: saravanan2003-hub
Repo: scalekit-inc/developer-docs PR: 564
File: package.json:6-6
Timestamp: 2026-04-02T10:00:03.444Z
Learning: In scalekit-inc/developer-docs, the `dev` script in `package.json` uses `netlify dev --skip-wait-port` to allow the browser window to boot up quickly without waiting for the port to be available. The Astro Starlight docs server then wires itself up asynchronously afterward. This avoids a race condition between Netlify CLI and Astro's dev server startup.
Applied to files:
package.jsonscripts/generate-llms-index.js
📚 Learning: 2026-03-25T16:04:34.150Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 532
File: astro.config.mjs:302-302
Timestamp: 2026-03-25T16:04:34.150Z
Learning: In scalekit-inc/developer-docs, the D2 diagram generation behavior (skipped when the `NETLIFY` env var is set via `netlify dev`) is already documented in CONTRIBUTING.md. Do not flag missing documentation for this behavior in `astro.config.mjs`.
Applied to files:
package.json
📚 Learning: 2026-03-31T16:14:24.575Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: public/AGENTS.md:0-0
Timestamp: 2026-03-31T16:14:24.575Z
Learning: Applies to public/**/*.{js,ts,jsx,tsx} : Node.js SDK should use the variable name `scalekit`
Applied to files:
package.json
📚 Learning: 2026-03-26T11:25:44.361Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 538
File: src/content.config.ts:66-74
Timestamp: 2026-03-26T11:25:44.361Z
Learning: In `src/content.config.ts`, the `scalekit-inc/scalekit-expo-sdk` repo is intentionally present in the `github-releases` loader but absent from the `sdk-references` loader. This is by design: release version tracking is needed for the Expo SDK even though it does not yet have a `REFERENCE.md` file. Do not flag this divergence as a sync issue in future reviews.
Applied to files:
package.json
📚 Learning: 2026-04-20T11:29:40.242Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-04-20T11:29:40.242Z
Learning: Applies to **/*.{md,mdx} : Use exact SDK variable names: Node.js: `scalekit`, Python: `scalekit_client`, Go: `scalekitClient`, Java: `scalekitClient`
Applied to files:
package.json
📚 Learning: 2026-01-13T12:48:11.566Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursor/rules/documentation-guide.mdc:0-0
Timestamp: 2026-01-13T12:48:11.566Z
Learning: Applies to **/*.{md,mdx} : Keep documentation synchronized with product changes
Applied to files:
scripts/generate-llms-index.jssrc/configs/llms.config.ts
📚 Learning: 2026-01-13T12:48:11.566Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursor/rules/documentation-guide.mdc:0-0
Timestamp: 2026-01-13T12:48:11.566Z
Learning: Applies to **/*.{md,mdx} : Structure documentation content with clear headings for better search understanding
Applied to files:
scripts/generate-llms-index.js
📚 Learning: 2026-01-13T12:48:11.566Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursor/rules/documentation-guide.mdc:0-0
Timestamp: 2026-01-13T12:48:11.566Z
Learning: Applies to **/*.{md,mdx} : Maintain proper heading hierarchy and list semantics in documentation for accessibility
Applied to files:
scripts/generate-llms-index.js
📚 Learning: 2026-03-25T10:15:02.544Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 529
File: src/content/docs/agent-auth/mcp/tool-access-via-mcp.mdx:188-190
Timestamp: 2026-03-25T10:15:02.544Z
Learning: In scalekit-inc/developer-docs, the Aside note in `src/content/docs/agent-auth/mcp/tool-access-via-mcp.mdx` warning that ChatGPT's beta MCP connector "may not work correctly" and "does not fully implement the MCP specification" is intentional. Real-world developers have reported re-auth loops and inconsistent streamable HTTP behaviour with ChatGPT compared to Claude, even though OpenAI's marketing describes it as "full MCP support". Do not flag or suggest removing this compatibility warning in future reviews.
Applied to files:
scripts/generate-llms-index.js
📚 Learning: 2026-04-22T09:59:00.346Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 623
File: src/content/docs/agentkit/bring-your-own-connector/using-tool-proxy.mdx:197-227
Timestamp: 2026-04-22T09:59:00.346Z
Learning: In `src/content/docs/agentkit/bring-your-own-connector/using-tool-proxy.mdx`, the `execute_tool` code examples (Node.js and Python) under the "MCP tool calling" section intentionally omit client initialization boilerplate (`ScalekitClient` setup, env loading, variable declarations). They are continuation snippets that rely on the client already defined in the `list_scoped_tools` discovery block above. Do not flag these as lacking self-contained initialization in future reviews.
Applied to files:
scripts/generate-llms-index.js
📚 Learning: 2026-04-20T11:29:40.242Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-04-20T11:29:40.242Z
Learning: Applies to src/content/docs/agentkit/**/*.{md,mdx} : Agentkit code examples live in the external repo **scalekit-developers/agent-auth-examples** organized as `javascript/frameworks/<framework>` and `python/frameworks/<framework>`; verify docs snippets match current implementations in that repo
Applied to files:
scripts/generate-llms-index.jssrc/configs/llms.config.ts
📚 Learning: 2026-04-20T17:03:02.786Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 619
File: src/components/templates/agent-connectors/_usage-posthogmcp.mdx:82-82
Timestamp: 2026-04-20T17:03:02.786Z
Learning: In `src/components/templates/agent-connectors/_usage-posthogmcp.mdx`, the trailing `## Scalekit Tools` heading is intentionally omitted. The parent connector page (`src/content/docs/agentkit/connectors/posthogmcp.mdx`) renders the tool list separately via the `ToolList` component and the imported `tools` dataset, so the structural anchor heading used by other `_usage-*.mdx` templates is not needed here. Do not flag the missing `## Scalekit Tools` heading in this file.
Applied to files:
scripts/generate-llms-index.js
📚 Learning: 2026-04-13T10:43:05.628Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 590
File: src/components/templates/agent-connectors/_usage-databricks.mdx:83-83
Timestamp: 2026-04-13T10:43:05.628Z
Learning: In `src/components/templates/agent-connectors/_usage-*.mdx` files, the trailing `## Scalekit Tools` heading at the end of every usage template is intentional and consistent across all 42+ connector usage templates. It acts as a structural anchor/separator that the parent connector reference page uses to append the tool-list section beneath the proxy API examples. Do not flag this heading as empty or duplicate in future reviews of these template files.
Applied to files:
scripts/generate-llms-index.jssrc/configs/llms.config.ts
📚 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:
scripts/generate-llms-index.js
📚 Learning: 2026-04-01T14:52:05.113Z
Learnt from: srinivaskarre-sk
Repo: scalekit-inc/developer-docs PR: 566
File: src/content/docs/agent-auth/user-verification.mdx:0-0
Timestamp: 2026-04-01T14:52:05.113Z
Learning: In `src/content/docs/agent-auth/user-verification.mdx`, the magic link creation and verify API code snippets (Python and Node.js) intentionally omit try/catch and try/except error handling to keep the step-by-step guide easy to follow. Error semantics (state mismatch, verification failure, CSRF protection) are covered in the surrounding prose and Aside components. Do not flag the absence of error paths in these specific snippets in future reviews.
Applied to files:
scripts/generate-llms-index.js
📚 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:
scripts/generate-llms-index.js
📚 Learning: 2026-03-25T16:00:29.351Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 531
File: src/content/docs/reference/agent-connectors/granolamcp.mdx:52-58
Timestamp: 2026-03-25T16:00:29.351Z
Learning: In `src/content/docs/reference/agent-connectors/**` (agent-connector reference pages, e.g., granolamcp.mdx), short sequential setup steps (4 items or fewer) may use plain Markdown numbered lists instead of the Starlight `<Steps>` component to avoid visual clutter when the page already contains multiple structured content blocks (tables, details/summary blocks, tool sections). Do not flag or require `<Steps>` for these short setup procedures on agent-connector reference pages.
Applied to files:
scripts/generate-llms-index.js
📚 Learning: 2026-03-13T03:44:23.786Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 489
File: src/content/docs/reference/agent-connectors/youtube.mdx:19-26
Timestamp: 2026-03-13T03:44:23.786Z
Learning: In src/content/docs/reference/agent-connectors/*.mdx files, small raw HTML <div> blocks used for the connector header grid layout (e.g., a 5-column grid with description and logo) are considered readable without a justification comment. Do not flag the absence of a justification comment on these simple connector-header div blocks in agent-connector reference pages.
Applied to files:
scripts/generate-llms-index.js
📚 Learning: 2026-04-20T11:29:40.242Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-04-20T11:29:40.242Z
Learning: Product-based documentation (MCP Auth, Agent Auth, Full Stack Auth, Modular SCIM, Modular SSO) must follow a journey-focused approach representing a developer's journey toward implementing authentication
Applied to files:
scripts/generate-llms-index.jssrc/configs/llms.config.ts
📚 Learning: 2026-04-20T11:30:52.410Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-20T11:30:52.410Z
Learning: Product-based documentation (MCP Auth, Agent Auth, Full Stack Auth, Modular SCIM, Modular SSO) MUST follow a journey-focused approach. Each product represents a developer's journey toward implementing authentication in their projects
Applied to files:
scripts/generate-llms-index.jssrc/configs/llms.config.ts
📚 Learning: 2026-04-20T11:30:52.410Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-20T11:30:52.410Z
Learning: Applies to **/*.{md,mdx} : Every page MUST include frontmatter with at least: `title`, `description`, and `sidebar.label`
Applied to files:
scripts/generate-llms-index.jssrc/configs/llms.config.ts
📚 Learning: 2026-04-20T11:29:40.242Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-04-20T11:29:40.242Z
Learning: Applies to src/content/docs/**/*.{md,mdx} : Every documentation page must include frontmatter with at least: `title` (≤60 chars), `description` (≤160 chars), and `sidebar.label` (1-3 words)
Applied to files:
scripts/generate-llms-index.js
📚 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 : Set appropriate sidebar labels for navigation in frontmatter
Applied to files:
scripts/generate-llms-index.js
📚 Learning: 2026-01-13T12:47:52.148Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursor/rules/deno-docs-style.mdc:0-0
Timestamp: 2026-01-13T12:47:52.148Z
Learning: Applies to **/*.{md,mdx} : 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
Applied to files:
scripts/generate-llms-index.js
📚 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 comprehensive descriptions in frontmatter metadata
Applied to files:
scripts/generate-llms-index.js
📚 Learning: 2026-02-18T18:25:59.260Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 438
File: CONTRIBUTING.md:1-7
Timestamp: 2026-02-18T18:25:59.260Z
Learning: In scalekit-inc/developer-docs, root-level markdown files like CONTRIBUTING.md and README.md are standard GitHub repository files and do not require frontmatter. Only MDX files under src/content/docs/ that are processed by the Starlight docs system need frontmatter with title, description, and navigation metadata.
Applied to files:
scripts/generate-llms-index.js
📚 Learning: 2026-01-13T12:46:55.260Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursorrules:0-0
Timestamp: 2026-01-13T12:46:55.260Z
Learning: Applies to **/*.mdx : Use descriptive page titles and meta descriptions for SEO in MDX frontmatter
Applied to files:
scripts/generate-llms-index.js
📚 Learning: 2026-02-04T12:47:25.438Z
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:25.438Z
Learning: In the scalekit-inc/developer-docs repository, the `order` frontmatter field in MDX files is only required when the sidebar configuration points to a directory (for auto-generation). When the sidebar explicitly references a file path in `sidebar.config.ts`, the `order` field is not required.
Applied to files:
scripts/generate-llms-index.jssrc/configs/llms.config.ts
📚 Learning: 2026-04-20T11:30:52.410Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-20T11:30:52.410Z
Learning: Applies to **/*.{md,mdx} : Include optional `head` field in frontmatter for custom styles to ensure consistent heading sizing
Applied to files:
scripts/generate-llms-index.js
📚 Learning: 2026-04-20T11:29:40.242Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-04-20T11:29:40.242Z
Learning: Applies to src/content/docs/**/*.{md,mdx} : Split content into clear sections with descriptive, sentence-style titles; include a table of contents for documents with multiple sections; keep paragraphs short and isolate critical points in their own short paragraphs
Applied to files:
scripts/generate-llms-index.js
📚 Learning: 2026-04-20T11:29:40.242Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-04-20T11:29:40.242Z
Learning: Applies to src/content/docs/**/*.{md,mdx} : Page organization should follow: opening context, optional collapsible supplementary sections, main content sections, and optional closing 'next steps' or summary; closing section may be omitted when frontmatter `prev`/`next` links provide navigation
Applied to files:
scripts/generate-llms-index.js
📚 Learning: 2026-04-20T11:30:52.410Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-20T11:30:52.410Z
Learning: Applies to **/*.{md,mdx} : Page organization SHOULD follow: opening context, optional collapsible supplementary sections, main content sections, and an optional closing 'next steps' or summary
Applied to files:
scripts/generate-llms-index.js
📚 Learning: 2026-04-20T11:30:52.410Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-20T11:30:52.410Z
Learning: Applies to **/*.{md,mdx} : Split content into clear sections with descriptive, sentence-style titles that convey meaning without requiring the following paragraph
Applied to files:
scripts/generate-llms-index.js
📚 Learning: 2026-01-30T18:20:07.851Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 415
File: src/content/docs/authenticate/fsa/multiapp/native-app.mdx:1-6
Timestamp: 2026-01-30T18:20:07.851Z
Learning: In the scalekit-inc/developer-docs repository, MDX files under `src/content/docs/authenticate/fsa/multiapp/` do not use `order` or `tags` fields in their frontmatter. Ordering and grouping are managed centrally in `src/configs/sidebar.config.ts`.
Applied to files:
scripts/generate-llms-index.jssrc/configs/llms.config.ts
📚 Learning: 2026-01-13T12:48:11.566Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursor/rules/documentation-guide.mdc:0-0
Timestamp: 2026-01-13T12:48:11.566Z
Learning: Applies to **/*.{md,mdx} : Follow a logical heading hierarchy (H2, H3, H4) and keep sections focused and scannable
Applied to files:
scripts/generate-llms-index.js
📚 Learning: 2026-04-20T11:29:40.242Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-04-20T11:29:40.242Z
Learning: Applies to src/content/docs/**/*.{md,mdx} : Concept pages must include Overview, How it works, Key concepts, Use cases, Trade-offs (where relevant), Best practices, and Related guides
Applied to files:
scripts/generate-llms-index.jssrc/configs/llms.config.ts
📚 Learning: 2026-04-20T11:30:52.410Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-20T11:30:52.410Z
Learning: Applies to **/*.{md,mdx} : Concept pages MUST include: Overview, How it works, Key concepts, Use cases, Trade-offs (where relevant), Best practices, and Related guides
Applied to files:
scripts/generate-llms-index.jssrc/configs/llms.config.ts
📚 Learning: 2026-04-20T11:30:52.410Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-20T11:30:52.410Z
Learning: Applies to **/*.{md,mdx} : Use normal section headings instead of `<Steps>` when content is mostly `<Tabs>`, long JSX blocks, or multiple embedded components
Applied to files:
scripts/generate-llms-index.js
📚 Learning: 2026-03-09T10:26:58.650Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 471
File: src/content/docs/dev-kit/ai-assisted-development/context7.mdx:9-10
Timestamp: 2026-03-09T10:26:58.650Z
Learning: In scalekit-inc/developer-docs, standalone utility/reference pages under src/content/docs/dev-kit/ that are not part of a sequential product journey (e.g., context7.mdx under dev-kit/ai-assisted-development/) may intentionally use `prev: false` and `next: false` in frontmatter. Do not flag the absence of prev/next navigation or a "what's next" signal on such pages.
Applied to files:
scripts/generate-llms-index.js
📚 Learning: 2026-01-13T12:47:52.148Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursor/rules/deno-docs-style.mdc:0-0
Timestamp: 2026-01-13T12:47:52.148Z
Learning: Applies to **/*.{md,mdx} : Start documentation pages with a one-paragraph overview explaining what the page covers and when to use it
Applied to files:
scripts/generate-llms-index.jssrc/configs/llms.config.ts
📚 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:
scripts/generate-llms-index.jssrc/configs/llms.config.ts
📚 Learning: 2026-04-20T11:30:52.410Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-20T11:30:52.410Z
Learning: Documentation must be organized into logical sections (FSA, SSO, Directory/SCIM, Connect, M2M, Guides, Reference) with proper sidebar configuration and navigation structure
Applied to files:
scripts/generate-llms-index.jssrc/configs/llms.config.ts
📚 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:
scripts/generate-llms-index.jssrc/configs/llms.config.ts
📚 Learning: 2026-01-13T12:48:11.566Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursor/rules/documentation-guide.mdc:0-0
Timestamp: 2026-01-13T12:48:11.566Z
Learning: Applies to **/*.{md,mdx} : Start with an overview/value proposition and when to use the feature before detailed instructions
Applied to files:
scripts/generate-llms-index.jssrc/configs/llms.config.ts
📚 Learning: 2026-04-20T11:29:40.242Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-04-20T11:29:40.242Z
Learning: Applies to {src/content/docs/guides/integrations/**/*.{md,mdx},src/components/templates/_*.{ts,tsx,astro}} : Integration guides in `src/content/docs/guides/integrations/` must be kept synchronized with their corresponding index pages and use reusable template components from `src/components/templates/`
Applied to files:
src/configs/llms.config.ts
📚 Learning: 2026-03-26T13:43:56.358Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 539
File: src/content/docs/cookbooks/search-scalekit-docs-in-your-ide.mdx:1-15
Timestamp: 2026-03-26T13:43:56.358Z
Learning: In scalekit-inc/developer-docs, the `/cookbooks` directory (src/content/docs/cookbooks/**/*.mdx) uses directory-based auto-generation in src/configs/sidebar.config.ts (mapped as '/cookbooks' and '/cookbooks/**/*'). Therefore, sidebar.label is NOT required in frontmatter for cookbook pages. Do not flag missing sidebar.label for files under this directory.
Applied to files:
src/configs/llms.config.ts
📚 Learning: 2026-02-26T07:18:51.377Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 448
File: scripts/sync-agent-connectors.js:0-0
Timestamp: 2026-02-26T07:18:51.377Z
Learning: In src/content/docs/reference/agent-connectors/**/*.mdx files, sidebar.label frontmatter is not required because the sidebar configuration references the agent-connectors directory for auto-generation. Navigation ordering and grouping are managed centrally in the sidebar configuration file.
Applied to files:
src/configs/llms.config.ts
📚 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/configs/llms.config.ts
📚 Learning: 2026-03-31T16:14:24.575Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: public/AGENTS.md:0-0
Timestamp: 2026-03-31T16:14:24.575Z
Learning: Use Scalekit official plugin for AI coding agents (Claude Code, GitHub Copilot, Codex, or Skills CLI/Windsurf/Cline) to reduce hallucinations and improve code generation accuracy
Applied to files:
src/configs/llms.config.ts
📚 Learning: 2026-03-29T07:48:47.916Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 546
File: public/api/scalekit.scalar.yaml:5947-5996
Timestamp: 2026-03-29T07:48:47.916Z
Learning: In scalekit-inc/developer-docs, hiding the /api/v1/users/support-hash route from the public OpenAPI (public/api/scalekit.scalar.yaml) is intentional. The site keeps an internal proxy at src/pages/api/v1/users/support-hash.ts, and public/js/pylon-widget.js relies on it for Pylon verification. Do not flag the spec’s omission of this path as requiring code-side removal of the proxy or widget.
Applied to files:
src/configs/llms.config.ts
📚 Learning: 2026-01-13T12:47:12.462Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursor/rules/browsecentral-labels.mdc:0-0
Timestamp: 2026-01-13T12:47:12.462Z
Learning: Applies to **/*.{yml,yaml,md,mdx} : BrowseCentral labels should include specific context when needed (e.g., 'Configure Scalekit MCP server', 'Validate incoming API requests')
Applied to files:
src/configs/llms.config.ts
📚 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/configs/llms.config.ts
📚 Learning: 2026-04-20T11:30:52.410Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-20T11:30:52.410Z
Learning: Applies to src/content/docs/guides/integrations/**/*.{md,mdx} : Integration guides in `src/content/docs/guides/integrations/` MUST be kept synchronized with their index pages
Applied to files:
src/configs/llms.config.ts
📚 Learning: 2026-04-20T11:30:52.410Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-20T11:30:52.410Z
Learning: Applies to **/*.{md,mdx} : Use `prev`/`next` for sequential guides; use `seeAlso` for related guides in frontmatter
Applied to files:
src/configs/llms.config.ts
📚 Learning: 2026-04-20T11:30:52.410Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-20T11:30:52.410Z
Learning: Applies to **/*.{md,mdx} : API reference pages MUST include: Endpoint Summary, Authentication, Base URL, Parameters, Request, Response, and Errors (with tables)
Applied to files:
src/configs/llms.config.ts
📚 Learning: 2026-04-20T11:29:40.242Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-04-20T11:29:40.242Z
Learning: Applies to src/content/docs/**/*.{md,mdx} : API references must include Endpoint Summary, Authentication, Base URL, Parameters, Request, Response, and Errors (with tables)
Applied to files:
src/configs/llms.config.ts
📚 Learning: 2026-01-13T12:48:11.566Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursor/rules/documentation-guide.mdc:0-0
Timestamp: 2026-01-13T12:48:11.566Z
Learning: Applies to **/*.{md,mdx} : Provide links to related concepts, guides, and references in documentation
Applied to files:
src/configs/llms.config.ts
📚 Learning: 2026-04-20T11:30:52.410Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-20T11:30:52.410Z
Learning: Applies to **/*.{md,mdx} : Every documentation page MUST fit one primary document type and follow its recommended structure: How-to Guide, API Reference, Concept Page, or Release Notes / Change Log
Applied to files:
src/configs/llms.config.ts
📚 Learning: 2026-04-20T11:29:40.242Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-04-20T11:29:40.242Z
Learning: Applies to src/content/docs/**/*.{md,mdx} : Prioritize topics and explanations by value and frequency of use; never teach bad habits or insecure patterns (never hard-code secrets or API keys)
Applied to files:
src/configs/llms.config.ts
📚 Learning: 2026-04-20T11:30:52.410Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-20T11:30:52.410Z
Learning: Applies to **/*.{md,mdx} : Prioritize topics and explanations by value and frequency of use
Applied to files:
src/configs/llms.config.ts
📚 Learning: 2026-01-13T12:47:52.148Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursor/rules/deno-docs-style.mdc:0-0
Timestamp: 2026-01-13T12:47:52.148Z
Learning: Applies to **/*.{md,mdx} : Prefer CLI-first examples and show file layout when helpful in documentation
Applied to files:
src/configs/llms.config.ts
📚 Learning: 2026-01-13T12:47:52.148Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursor/rules/deno-docs-style.mdc:0-0
Timestamp: 2026-01-13T12:47:52.148Z
Learning: Applies to **/*.{md,mdx} : Present the primary use case (80% path) first in documentation, with edge cases later
Applied to files:
src/configs/llms.config.ts
📚 Learning: 2026-01-13T12:48:11.566Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursor/rules/documentation-guide.mdc:0-0
Timestamp: 2026-01-13T12:48:11.566Z
Learning: Applies to **/*.{md,mdx} : Don't create overly long, unfocused documentation content
Applied to files:
src/configs/llms.config.ts
📚 Learning: 2026-04-20T11:29:40.242Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-04-20T11:29:40.242Z
Learning: Applies to src/content/docs/**/*.{md,mdx} : Every documentation page must fit one primary type and follow its recommended structure: How-to Guide, API Reference, Concept Page, or Release Notes / Change Log
Applied to files:
src/configs/llms.config.ts
📚 Learning: 2026-04-20T11:30:52.410Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-20T11:30:52.410Z
Learning: Applies to **/*.{md,mdx} : Use `sidebar.order` only when navigation ordering matters
Applied to files:
src/configs/llms.config.ts
📚 Learning: 2026-04-20T11:30:52.410Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-20T11:30:52.410Z
Learning: Applies to **/*.{md,mdx} : Proactively address common setup and configuration problems
Applied to files:
src/configs/llms.config.ts
📚 Learning: 2026-01-13T12:48:11.566Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursor/rules/documentation-guide.mdc:0-0
Timestamp: 2026-01-13T12:48:11.566Z
Learning: Applies to **/*.{md,mdx} : Set concise sidebar labels that match user vocabulary in navigation metadata
Applied to files:
src/configs/llms.config.ts
🔇 Additional comments (2)
package.json (2)
77-77: DroppnpmfromdevDependencies— already pinned viapackageManager.Same concern as flagged on the prior commit: with
packageManager: "pnpm@10.33.1"(line 5) driving Corepack/pnpm/action-setup@v4, listing"pnpm": "^10.33.1"here is redundant and lets a contributor'spnpm installresolve any newer 10.x, drifting from the pinned10.33.1. It also pulls pnpm into the project's dependency graph for no benefit.♻️ Proposed fix
"netlify-cli": "^25.3.0", - "pnpm": "^10.33.1", "prettier": "^3.8.3",
23-29: Astro v6 ecosystem upgrade — confirmed intentional, prior "stay on 5.x" learning is superseded.This PR explicitly upgrades the Astro stack to v6 (
astro@6.1.9,@astrojs/mdx@5,@astrojs/netlify@7,@astrojs/vue@6,@astrojs/starlight-tailwind@5,@astrojs/starlight@0.38.3). A previous learning (PR 564) noted these were intentionally pinned to Astro 5.x for compatibility — that constraint is being lifted here, with the PR's test plan (pnpm installclean, dev/preview, production build, links-validator, /agentkit/* 200s) covering the migration. No action needed; flagging only so the prior learning isn't re-applied in future reviews. Based on learnings (PR 564, package.json:22-28).Please confirm
astro checkpasses locally with the new versions, and that@astrojs/starlight-docsearch(vendored) is also Astro 6 compatible — its peer range isn't visible from this diff.
- Fix curl single-quote bug in create-connector.mdx — env vars were not expanding - Fix trailing-hyphen anchors in add-modular-sso.mdx and sso/quickstart.mdx - Fix malformed URL in llms-judge-prompt.txt (docs.scalekit.com.md → docs.scalekit.com/) - Replace deleted BYOC page links in llms-judge-prompt.txt with current pages - Fix AgentKit Frameworks description in generate-llms-index.js (Agno/MCP → Claude Managed Agents) - Use readdir withFileTypes to skip extra stat() per entry in walk() - Remove dead /agentkit/mcp/ disjunct in OTHER_SECTIONS matcher - Remove redundant pnpm from devDependencies (already pinned via packageManager field) - Fix tag inconsistency in create-connector.mdx (agentauth → agentkit) - Fix circular phrasing in bring-your-own-connector/overview.mdx step 4
saif-at-scalekit
approved these changes
Apr 27, 2026
Collaborator
saif-at-scalekit
left a comment
saif-at-scalekit
left a comment
There was a problem hiding this comment.
Separated out Github workflows into #635
Rest of the PR looks good to me.
Contributor
There was a problem hiding this comment.
Actionable comments posted: 2
♻️ Duplicate comments (1)
scripts/generate-llms-index.js (1)
118-120:⚠️ Potential issue | 🟠 MajorSpecial-case the site root in
mdUrl().Line 119 strips the only slash from
'/', so the Home entry written at Lines 295-299 becomeshttps://docs.scalekit.com.md. That leaves the top link in the generatedllms.txtbroken.Proposed fix
function mdUrl(urlPath) { - return `${BASE_URL}${urlPath.replace(/\/$/, '')}.md` + const path = urlPath === '/' ? '/index.html' : urlPath.replace(/\/$/, '') + return `${BASE_URL}${path}.md` }🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@scripts/generate-llms-index.js` around lines 118 - 120, The mdUrl function special-case is missing: when urlPath === '/' the current replace removes the only slash and yields BASE_URL + '.md' (e.g. https://docs.scalekit.com.md). Update mdUrl to check if urlPath === '/' and return a correct root markdown URL (for example return `${BASE_URL}/.md` or `${BASE_URL}index.md` depending on project convention), otherwise keep the existing behavior using urlPath.replace(/\/$/, '') + '.md'; modify the mdUrl function accordingly.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@llms-judge-prompt.txt`:
- Around line 38-64: The VERSION_B snapshot in llms-judge-prompt.txt is stale;
change its source to the real generator output instead of hand-editing. Update
the code that sets VERSION_B to read the generated llms.txt (or a checked-in
fixture produced by scripts/generate-llms-index.js) so the routing block and
"AgentKit Frameworks" content (references like AgentKit/examples, Claude Managed
Agents, Google GenAI/Agno/MCP) reflect the actual generator output; replace the
hard-coded text assignment with a loader that reads and injects the generated
content at build/test time.
In `@package.json`:
- Around line 9-11: The strict markdown audit script
("agent-markdown:audit:strict") is defined but never executed; wire it into a
validation path by either adding it back to the build pipeline or git hooks or
creating a CI workflow: update the "build" script to run npm run
agent-markdown:audit:strict after "astro build" (i.e., append && npm run
agent-markdown:audit:strict to the "build" script), or reintroduce a pre-push
hook that runs npm run agent-markdown:audit:strict (update the pre-push hook
entry to invoke that script), or add a GitHub Actions workflow that runs npm ci
and npm run agent-markdown:audit:strict on pull_request/push to ensure the audit
is enforced; target the package.json scripts ("build",
"agent-markdown:audit:strict") and the pre-push hook or new workflow as the
change points.
---
Duplicate comments:
In `@scripts/generate-llms-index.js`:
- Around line 118-120: The mdUrl function special-case is missing: when urlPath
=== '/' the current replace removes the only slash and yields BASE_URL + '.md'
(e.g. https://docs.scalekit.com.md). Update mdUrl to check if urlPath === '/'
and return a correct root markdown URL (for example return `${BASE_URL}/.md` or
`${BASE_URL}index.md` depending on project convention), otherwise keep the
existing behavior using urlPath.replace(/\/$/, '') + '.md'; modify the mdUrl
function accordingly.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: 4c890a8b-4bcb-4c52-b3d0-cdc9e7cd35f2
📒 Files selected for processing (9)
.simple-git-hooks.jsonllms-judge-prompt.txtpackage.jsonscripts/generate-llms-index.jsscripts/log-preview-url.jssrc/configs/redirects.config.tssrc/content/docs/agentkit/bring-your-own-connector/create-connector.mdxsrc/content/docs/agentkit/bring-your-own-connector/overview.mdxsrc/content/docs/agentkit/mcp/tool-access-via-mcp.mdx
💤 Files with no reviewable changes (1)
- scripts/log-preview-url.js
…iption - Replace /agentkit/frameworks/ paths with /agentkit/examples/ (frameworks/ dir no longer exists) - Remove Agno, Google GenAI, MCP routing entries (no pages under examples/) - Add Claude Managed Agents routing entry - Update AgentKit Frameworks description to match generate-llms-index.js
Collaborator
|
@coderabbitai if there are no more comments to address, please approve |
Contributor
|
Tip For best results, initiate chat on the files or code changes. 🧩 Analysis chain🏁 Script executed: Length of output: 154547
[approve] ✏️ Learnings added
🧠 Learnings usedIf you found this review helpful, would you consider giving us a shout-out on X? Thank you for using CodeRabbit! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
husky(project usessimple-git-hooksexclusively)pnpm,@types/react,@types/react-domfromdependencies→devDependenciespackageManagerfield (pnpm@10.33.1) for version enforcementsimple-git-hookstopnpm.onlyBuiltDependencies(silences install warning)@astrojs/react,@iconify/json,@scalar/*,tailwindcss,vue,netlify-cli,pnpmastro@6.1.9,@astrojs/starlight@0.38.3,@astrojs/mdx@5,@astrojs/netlify@7,@astrojs/vue@6,@astrojs/starlight-tailwind@5vite-plugin-static-copypatch for v4.1.0 (same fix, upstream PR SSO indentifiers for each SDK #240 still open)Test plan
pnpm installclean with no unexpected peer warningsstarlight-links-validator)/agentkit/*paths verified 200 with correct page titles.agent.mdfiles generated correctlyPreview
https://deploy-preview-{PR_NUMBER}--scalekit-starlight.netlify.app/agentkit/quickstart/
Summary by CodeRabbit
New Features
Bug Fixes
Documentation
Performance
Chores