Skip to content

Combine Claude Code install steps into single CLI command#683

Open
saif-at-scalekit wants to merge 2 commits into
mainfrom
update/build-with-ai-page
Open

Combine Claude Code install steps into single CLI command#683
saif-at-scalekit wants to merge 2 commits into
mainfrom
update/build-with-ai-page

Conversation

@saif-at-scalekit
Copy link
Copy Markdown
Collaborator

@saif-at-scalekit saif-at-scalekit commented May 12, 2026

Replaces the two-step Claude REPL install flow with a single claude CLI command that adds the marketplace and installs the auth plugin in one go.

Scope: All pages and templates that reference Claude Code plugin installation — content pages, reusable template components, agent instruction configs, and public/AGENTS.md.

Changed files:

  • src/content/docs/dev-kit/build-with-ai/index.mdx
  • src/content/docs/home/saaskit/index.mdx
  • src/content/docs/authenticate/sso/add-modular-sso.mdx
  • src/content/docs/authenticate/fsa/quickstart.mdx
  • src/content/docs/authenticate/mcp/quickstart.mdx
  • src/content/docs/sso/quickstart.mdx
  • src/content/docs/passwordless/quickstart.mdx
  • src/content/docs/passwordless/oidc.mdx
  • src/content/docs/directory/scim/quickstart.mdx
  • src/components/templates/coding-agents/_agentkit-claude-code.mdx
  • src/components/templates/coding-agents/_mcp-auth-claude-code.mdx
  • src/components/templates/coding-agents/_sso-claude-code.mdx
  • src/components/templates/coding-agents/_scim-claude-code.mdx
  • src/components/templates/coding-agents/_fsa-claude-code.mdx
  • src/configs/agent-instructions.ts
  • public/AGENTS.md

Preview: https://deploy-preview-683--scalekit-starlight.netlify.app/dev-kit/build-with-ai/

Summary by CodeRabbit

  • Documentation
    • Consolidated and simplified the "Claude Code" installation instructions for the Scalekit Auth Stack: replaced the previous multi-step REPL-style setup with a single Terminal/bash command that adds the Scalekit marketplace and installs the appropriate auth plugin in one step, clarifying headings and renumbering subsequent guide steps for a smoother onboarding flow.

Review Change Stack

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 12, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: 12bc1360-e559-4793-965f-ca9c728a2c7d

📥 Commits

Reviewing files that changed from the base of the PR and between d5a307d and 21bec21.

📒 Files selected for processing (15)
  • public/AGENTS.md
  • src/components/templates/coding-agents/_agentkit-claude-code.mdx
  • src/components/templates/coding-agents/_fsa-claude-code.mdx
  • src/components/templates/coding-agents/_mcp-auth-claude-code.mdx
  • src/components/templates/coding-agents/_scim-claude-code.mdx
  • src/components/templates/coding-agents/_sso-claude-code.mdx
  • src/configs/agent-instructions.ts
  • src/content/docs/authenticate/fsa/quickstart.mdx
  • src/content/docs/authenticate/mcp/quickstart.mdx
  • src/content/docs/authenticate/sso/add-modular-sso.mdx
  • src/content/docs/directory/scim/quickstart.mdx
  • src/content/docs/home/saaskit/index.mdx
  • src/content/docs/passwordless/oidc.mdx
  • src/content/docs/passwordless/quickstart.mdx
  • src/content/docs/sso/quickstart.mdx
📜 Recent 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 (18)
**/*.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. ## Title with all step content indented with exactly 3 spaces
Use action-oriented headings in step-by-step guides within Steps components
Include code examples in all 4 languages (Node.js, Python, Go, Java) within Steps co...

Files:

  • src/components/templates/coding-agents/_scim-claude-code.mdx
  • src/content/docs/authenticate/mcp/quickstart.mdx
  • src/content/docs/sso/quickstart.mdx
  • src/content/docs/authenticate/fsa/quickstart.mdx
  • src/content/docs/home/saaskit/index.mdx
  • src/content/docs/passwordless/quickstart.mdx
  • src/content/docs/passwordless/oidc.mdx
  • src/content/docs/directory/scim/quickstart.mdx
  • src/components/templates/coding-agents/_fsa-claude-code.mdx
  • src/components/templates/coding-agents/_mcp-auth-claude-code.mdx
  • src/components/templates/coding-agents/_agentkit-claude-code.mdx
  • src/components/templates/coding-agents/_sso-claude-code.mdx
  • src/content/docs/authenticate/sso/add-modular-sso.mdx

⚙️ CodeRabbit configuration file

**/*.mdx: You are reviewing Scalekit developer documentation written in MDX
(Astro + Starlight framework). Apply ALL of the following checks:

Frontmatter

  • title MUST be ≤ 60 characters and clearly state what the page does.
  • description MUST be ≤ 160 characters, action-oriented, unique per page.
  • sidebar.label MUST be present and ≤ 30 characters.
  • sidebar.order MUST 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 / next links 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).
  • Headings that match a real API parameter, method, or field name
    (e.g., contactID, xero_tenant_id, executeTool) should preserve
    the original casing. Do NOT flag these as sentence-case violations.
  • 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 to src/content/docs/cookbooks/**
    (blog-style recipes — optional <Steps>, <Tabs> after </Steps> OK;
    see cookbooks path_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: f...

Files:

  • src/components/templates/coding-agents/_scim-claude-code.mdx
  • src/content/docs/authenticate/mcp/quickstart.mdx
  • src/content/docs/sso/quickstart.mdx
  • src/content/docs/authenticate/fsa/quickstart.mdx
  • src/content/docs/home/saaskit/index.mdx
  • src/content/docs/passwordless/quickstart.mdx
  • src/content/docs/passwordless/oidc.mdx
  • src/content/docs/directory/scim/quickstart.mdx
  • src/components/templates/coding-agents/_fsa-claude-code.mdx
  • src/components/templates/coding-agents/_mcp-auth-claude-code.mdx
  • src/components/templates/coding-agents/_agentkit-claude-code.mdx
  • src/components/templates/coding-agents/_sso-claude-code.mdx
  • src/content/docs/authenticate/sso/add-modular-sso.mdx
**/*.{yml,yaml,md,mdx}

📄 CodeRabbit inference engine (.cursor/rules/browsecentral-labels.mdc)

**/*.{yml,yaml,md,mdx}: BrowseCentral labels should be maximum 3-5 words - keep concise but add context when needed
BrowseCentral labels should be action-oriented - start with verbs when possible
BrowseCentral labels should be specific and clear - add context when simple labels are ambiguous
BrowseCentral labels should be outcome-focused - describe what users accomplish and the context
BrowseCentral labels should use 'Action + Object' pattern (e.g., 'Invite users', 'Restrict sign-up', 'Set up SCIM')
BrowseCentral labels should use feature names (e.g., 'Enterprise SSO', 'Passwordless quickstart')
BrowseCentral labels should describe task completion (e.g., 'Run migrations', 'Migrate auth', 'Merge identities')
BrowseCentral labels should include specific context when needed (e.g., 'Configure Scalekit MCP server', 'Validate incoming API requests')
BrowseCentral labels should use integration context when applicable (e.g., 'Build MCP auth with your existing auth system')
BrowseCentral labels should avoid instructional prefixes: 'How to', 'Guide to', 'Implement', 'Configure', 'Learn', 'Understand'
BrowseCentral labels should avoid verbose phrases: 'Step-by-step guide', 'Complete tutorial', 'Detailed documentation'
BrowseCentral labels should avoid weak verbs: 'Enable', 'Allow', 'Provide', 'Support'

Files:

  • src/components/templates/coding-agents/_scim-claude-code.mdx
  • src/content/docs/authenticate/mcp/quickstart.mdx
  • src/content/docs/sso/quickstart.mdx
  • src/content/docs/authenticate/fsa/quickstart.mdx
  • src/content/docs/home/saaskit/index.mdx
  • src/content/docs/passwordless/quickstart.mdx
  • src/content/docs/passwordless/oidc.mdx
  • src/content/docs/directory/scim/quickstart.mdx
  • src/components/templates/coding-agents/_fsa-claude-code.mdx
  • public/AGENTS.md
  • src/components/templates/coding-agents/_mcp-auth-claude-code.mdx
  • src/components/templates/coding-agents/_agentkit-claude-code.mdx
  • src/components/templates/coding-agents/_sso-claude-code.mdx
  • src/content/docs/authenticate/sso/add-modular-sso.mdx
**/*.{md,mdx}

📄 CodeRabbit inference engine (.cursor/rules/deno-docs-style.mdc)

**/*.{md,mdx}: Use sentence case for all titles and headings in MD/MDX documentation
Keep page titles short and descriptive (3–7 words when possible) in MD/MDX documentation
Use outcome-focused headings that describe results, not categories (e.g., 'Run a script' not 'Scripts')
Avoid gerunds in headings when an imperative works - prefer 'Configure proxies' over 'Configuring proxies'
Keep sidebar labels concise (1–3 words), use sentence case, and focus on outcomes or objects
Use sentence case in sidebar labels without punctuation
Set frontmatter title in sentence case with a clear outcome; description in one sentence (≤160 chars); sidebar.label as shorter form of title; enable tableOfContents on longer pages
Start documentation pages with a one-paragraph overview explaining what the page covers and when to use it
Present the primary use case (80% path) first in documentation, with edge cases later
Use numbered steps for task-focused sections in documentation, with each step beginning with a verb
Break up long documentation sections with subheadings every 3–6 paragraphs
Use asides for important notes, tips, cautions, and references in documentation
Provide runnable, minimal code examples that work as-is in documentation
Prefer CLI-first examples and show file layout when helpful in documentation
Label code blocks with titles for context (e.g., 'Terminal', 'main.ts') in documentation
Keep code block annotations brief and purposeful - annotate only what matters
Use consistent variable and file names across a documentation page
Use descriptive link text in documentation (e.g., 'See permission flags' not 'click here')
Prefer relative links for internal documentation pages and include anchors for section references
Reference APIs consistently using backticks for code, file names, CLI flags, and endpoints
Use backticks for code, file names, CLI flags, and endpoints in documentation
Use lists for options and features in documentation; tables only when comparisons are cleare...

Files:

  • src/components/templates/coding-agents/_scim-claude-code.mdx
  • src/content/docs/authenticate/mcp/quickstart.mdx
  • src/content/docs/sso/quickstart.mdx
  • src/content/docs/authenticate/fsa/quickstart.mdx
  • src/content/docs/home/saaskit/index.mdx
  • src/content/docs/passwordless/quickstart.mdx
  • src/content/docs/passwordless/oidc.mdx
  • src/content/docs/directory/scim/quickstart.mdx
  • src/components/templates/coding-agents/_fsa-claude-code.mdx
  • public/AGENTS.md
  • src/components/templates/coding-agents/_mcp-auth-claude-code.mdx
  • src/components/templates/coding-agents/_agentkit-claude-code.mdx
  • src/components/templates/coding-agents/_sso-claude-code.mdx
  • src/content/docs/authenticate/sso/add-modular-sso.mdx
**/*.{ts,tsx,py,go,java,mdx,md}

📄 CodeRabbit inference engine (CLAUDE.md)

**/*.{ts,tsx,py,go,java,mdx,md}: Use the exact SDK variable names: Node.js (scalekit), Python (scalekit_client), Go (scalekitClient), Java (scalekitClient)
Never hard-code secrets or API keys in code examples; use environment variables
Include security comments that state the threat, why the pattern is required, and what can go wrong if omitted

Files:

  • src/components/templates/coding-agents/_scim-claude-code.mdx
  • src/content/docs/authenticate/mcp/quickstart.mdx
  • src/content/docs/sso/quickstart.mdx
  • src/content/docs/authenticate/fsa/quickstart.mdx
  • src/content/docs/home/saaskit/index.mdx
  • src/content/docs/passwordless/quickstart.mdx
  • src/content/docs/passwordless/oidc.mdx
  • src/content/docs/directory/scim/quickstart.mdx
  • src/configs/agent-instructions.ts
  • src/components/templates/coding-agents/_fsa-claude-code.mdx
  • public/AGENTS.md
  • src/components/templates/coding-agents/_mcp-auth-claude-code.mdx
  • src/components/templates/coding-agents/_agentkit-claude-code.mdx
  • src/components/templates/coding-agents/_sso-claude-code.mdx
  • src/content/docs/authenticate/sso/add-modular-sso.mdx
**/*.{mdx,md}

📄 CodeRabbit inference engine (CLAUDE.md)

**/*.{mdx,md}: All code examples must use <Tabs syncKey="tech-stack"> format and include Node.js, Python, Go, and Java implementations (90% rule)
Use sentence case for all titles and headings in documentation
Use bold for first mention of important terms, UI elements, and dashboard paths (e.g., Dashboard > Authentication > Session Policy)
Use inline code for technical identifiers: variables, functions, endpoints, scopes, environment variables, file paths, and placeholders
Always include headers in tables; keep cell content concise and readable
Prefer fenced code blocks with language identifiers for all code; never use screenshots of code
Use descriptive link text; never use 'click here' or 'this' as link labels
Keep sentences simple, right-branching, and unambiguous; avoid ambiguous noun stacks and demonstrative pronouns
Use active voice; prefer 'Run the command' over 'The command should be run'
Use second person when giving instructions; address the reader as 'you'
Use present tense for procedures; 'This command installs…' not 'This command will install…'
Avoid hype, slang, and filler words like 'simply', 'just', 'obviously' in documentation
Use consistent terminology throughout; prefer standard names over synonyms
Explain security implications and threats for all security-related content
Use imperative verbs for procedure headings: 'Run a script' not 'Running a script'; 'Configure proxies' not 'Configuring proxies'
Headings must describe outcomes, not categories (good: 'Run a script'; bad: 'Scripts')
Split content into clear sections with descriptive, sentence-style titles that convey meaning without requiring the following paragraph
Keep paragraphs short; isolate critical points in their own short paragraphs
Begin sections and paragraphs with standalone topic sentences that preview content
Put the topic words at the beginning of topic sentences to support fast skimming
Put key takeaways and results at the top of documents and sections
Use bullets and tabl...

Files:

  • src/components/templates/coding-agents/_scim-claude-code.mdx
  • src/content/docs/authenticate/mcp/quickstart.mdx
  • src/content/docs/sso/quickstart.mdx
  • src/content/docs/authenticate/fsa/quickstart.mdx
  • src/content/docs/home/saaskit/index.mdx
  • src/content/docs/passwordless/quickstart.mdx
  • src/content/docs/passwordless/oidc.mdx
  • src/content/docs/directory/scim/quickstart.mdx
  • src/components/templates/coding-agents/_fsa-claude-code.mdx
  • public/AGENTS.md
  • src/components/templates/coding-agents/_mcp-auth-claude-code.mdx
  • src/components/templates/coding-agents/_agentkit-claude-code.mdx
  • src/components/templates/coding-agents/_sso-claude-code.mdx
  • src/content/docs/authenticate/sso/add-modular-sso.mdx
**/*.{md,mdx,astro,ts}

📄 CodeRabbit inference engine (CONTRIBUTING.md)

**/*.{md,mdx,astro,ts}: Use pnpm pretty-quick --staged via pre-commit git hook to auto-format all staged .md, .mdx, .astro, .ts files with Prettier
Run pnpm format to auto-format all .md, .mdx, .astro, .ts files before pushing changes

Files:

  • src/components/templates/coding-agents/_scim-claude-code.mdx
  • src/content/docs/authenticate/mcp/quickstart.mdx
  • src/content/docs/sso/quickstart.mdx
  • src/content/docs/authenticate/fsa/quickstart.mdx
  • src/content/docs/home/saaskit/index.mdx
  • src/content/docs/passwordless/quickstart.mdx
  • src/content/docs/passwordless/oidc.mdx
  • src/content/docs/directory/scim/quickstart.mdx
  • src/configs/agent-instructions.ts
  • src/components/templates/coding-agents/_fsa-claude-code.mdx
  • public/AGENTS.md
  • src/components/templates/coding-agents/_mcp-auth-claude-code.mdx
  • src/components/templates/coding-agents/_agentkit-claude-code.mdx
  • src/components/templates/coding-agents/_sso-claude-code.mdx
  • src/content/docs/authenticate/sso/add-modular-sso.mdx
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 as 1. ## ...
In MDX documentation files, numbered step lines must start at column 0. Do not indent the 1. ##, 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/authenticate/mcp/quickstart.mdx
  • src/content/docs/sso/quickstart.mdx
  • src/content/docs/authenticate/fsa/quickstart.mdx
  • src/content/docs/home/saaskit/index.mdx
  • src/content/docs/passwordless/quickstart.mdx
  • src/content/docs/passwordless/oidc.mdx
  • src/content/docs/directory/scim/quickstart.mdx
  • src/content/docs/authenticate/sso/add-modular-sso.mdx
src/content/docs/**/*.{mdx,md}

📄 CodeRabbit inference engine (CLAUDE.md)

src/content/docs/**/*.{mdx,md}: Every documentation page must include frontmatter with at least: title, description, and sidebar.label
Page titles must be ≤60 characters and descriptions must be ≤160 characters
Sidebar labels must be concise (1-3 words) and use sentence case without punctuation
Use <Steps> component with single continuous ordered list; numbered steps start at column 0, continuation content indented with exactly 3 spaces
Use relative links for internal pages; include anchors for sections
Include a table of contents for documents with multiple sections; enable tableOfContents: true in frontmatter

Files:

  • src/content/docs/authenticate/mcp/quickstart.mdx
  • src/content/docs/sso/quickstart.mdx
  • src/content/docs/authenticate/fsa/quickstart.mdx
  • src/content/docs/home/saaskit/index.mdx
  • src/content/docs/passwordless/quickstart.mdx
  • src/content/docs/passwordless/oidc.mdx
  • src/content/docs/directory/scim/quickstart.mdx
  • src/content/docs/authenticate/sso/add-modular-sso.mdx
src/content/**/*.mdx

📄 CodeRabbit inference engine (CONTRIBUTING.md)

src/content/**/*.mdx: All documentation must live as MDX files inside src/content/
Every documentation page must have frontmatter with title (≤60 characters), description (≤160 characters), sidebar label, order, and tags
Write documentation in second person using 'you' and 'your application', present tense for descriptions, and imperative for step-by-step instructions
Avoid filler phrases like 'simply', 'just', 'easily' in documentation and be direct
Explain security implications when relevant in documentation
Every code block demonstrating an SDK operation must include all four languages (Node.js, Python, Go, Java) using synced tabs with syncKey='tech-stack'
SDK variable names are fixed and must not be renamed: Node.js uses scalekit, Python uses scalekit_client, Go uses scalekitClient, Java uses scalekitClient

Files:

  • src/content/docs/authenticate/mcp/quickstart.mdx
  • src/content/docs/sso/quickstart.mdx
  • src/content/docs/authenticate/fsa/quickstart.mdx
  • src/content/docs/home/saaskit/index.mdx
  • src/content/docs/passwordless/quickstart.mdx
  • src/content/docs/passwordless/oidc.mdx
  • src/content/docs/directory/scim/quickstart.mdx
  • src/content/docs/authenticate/sso/add-modular-sso.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/mcp/quickstart.mdx
  • src/content/docs/authenticate/fsa/quickstart.mdx
  • 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:

  • src/configs/agent-instructions.ts
**/*.{js,ts,tsx,jsx,py,java,cs,go,cpp,c,rb,php,swift,kt,scala,rs,m,mm,groovy}

📄 CodeRabbit inference engine (.cursor/rules/comment-standards.mdc)

**/*.{js,ts,tsx,jsx,py,java,cs,go,cpp,c,rb,php,swift,kt,scala,rs,m,mm,groovy}: Good comments do not excuse unclear code - refactor the code to be self-explanatory instead of using comments to explain poorly written code; use better variable names, function names, and code structure
Comments should dispel confusion, not cause it - ensure comments clarify rather than obscure the code's purpose; avoid cryptic or joke comments
Explain unidiomatic code in comments - comment on code that might seem unnecessary or redundant and document why you chose a specific pattern over more common alternatives, especially when it deviates from team conventions
Provide links to the original source of copied code - always attribute code copied from external sources with URLs to Stack Overflow answers, GitHub repositories, or documentation
Include links to external references where helpful - reference standards, RFCs, and official documentation; link to relevant specifications when implementing protocols
Add comments when fixing bugs - document bug fixes with context about the issue, reference issue trackers and bug reports, and explain workarounds and their limitations
Use comments to mark incomplete implementations - use standard formats for TODO, FIXME, and NOTE comments with context about what needs to be done and reference issue trackers when possible
Always document public APIs with function/class comments - explain the purpose, parameters, return values, and exceptions; include usage examples for complex functions
Include file headers with copyright information, license, and authorship - provide a brief description of the file's purpose and document dependencies and requirements

Files:

  • src/configs/agent-instructions.ts
**/*.{js,ts,tsx,jsx}

📄 CodeRabbit inference engine (.cursor/rules/comment-standards.mdc)

Use JSDoc standards for all function, class, and complex logic comments in JavaScript/TypeScript - include parameter descriptions (@param), return values (@returns), types (@type), and descriptions; document exceptions and edge cases

Files:

  • src/configs/agent-instructions.ts
**/*.{ts,tsx}

📄 CodeRabbit inference engine (CLAUDE.md)

**/*.{ts,tsx}: Prefer interface for defining object shapes in TypeScript
Use camelCase for variable names

Files:

  • src/configs/agent-instructions.ts
**/*.{ts,tsx,py,go,java}

📄 CodeRabbit inference engine (CLAUDE.md)

**/*.{ts,tsx,py,go,java}: Use JSDoc/JavaDoc/docstring standards for function, class, and complex logic comments with parameter descriptions, return values, and types
Comments should not duplicate the code; explain what the code does conceptually, not literally
Use better variable names and structure instead of comments to explain poorly written code
Explain unidiomatic or redundant code in comments; clarify why a specific pattern was chosen
Document exceptions and edge cases in code comments
Include links to external references (standards, RFCs, official documentation) in comments where helpful
Add comments when fixing bugs; reference issue trackers
Use standard formats for TODO, FIXME, and NOTE comments

Files:

  • src/configs/agent-instructions.ts
**/*.{ts,tsx,js,json}

📄 CodeRabbit inference engine (CLAUDE.md)

Use pnpm for package management

Files:

  • src/configs/agent-instructions.ts
**/*.{ts,tsx,js,jsx,py,go,java}

📄 CodeRabbit inference engine (AGENTS.md)

**/*.{ts,tsx,js,jsx,py,go,java}: Comments should not duplicate the code; comments should add value beyond what's obvious. Use better variable names and structure instead of using comments to explain poorly written code
Don't use comments to excuse unclear code. Comments should dispel confusion, not cause it. Ensure comments clarify rather than obscure purpose
Explain unidiomatic code in comments: comment on code that might seem unnecessary or redundant; explain why you chose a specific pattern
Use JSDoc/JavaDoc/docstring standards for function, class, and complex logic comments including parameter descriptions, return values, types, and descriptions
Document exceptions and edge cases in code comments
Include links to external references in code comments where helpful (standards, RFCs, official documentation)
Add comments when fixing bugs; reference issue trackers
Use standard formats for TODO, FIXME, and NOTE comments in code

Files:

  • src/configs/agent-instructions.ts
**/*.{ts,js,mjs}

⚙️ CodeRabbit configuration file

**/*.{ts,js,mjs}: Do NOT enforce code-commenting style rules on these files.
Specifically, do not flag:

  • Comments that "duplicate" or restate what the code does.
  • Missing comments on bug fixes, workarounds, or issue references.
  • Missing inline documentation or explanatory comments.
    Code comments are at the author's discretion.

Files:

  • src/configs/agent-instructions.ts
🧠 Learnings (12)
📓 Common learnings
Learnt from: CR
Repo: scalekit-inc/developer-docs

Timestamp: 2026-05-12T15:34:23.941Z
Learning: Install and use the official Scalekit plugin for AI coding agents to reduce hallucinations and enable faster, more accurate code generation
Learnt from: CR
Repo: scalekit-inc/developer-docs

Timestamp: 2026-05-12T15:34:23.941Z
Learning: Scalekit documentation covers authentication infrastructure for B2B SaaS applications including Agent Auth, Full Stack Auth, SSO, SCIM, and M2M authentication
📚 Learning: 2026-02-25T03:34:41.147Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 444
File: src/content/docs/agent-auth/start-agent-auth-coding-agents.mdx:31-31
Timestamp: 2026-02-25T03:34:41.147Z
Learning: In MDX files, import { Code } from 'astrojs/starlight/components' only if the MDX content actually uses the <Code> component. If the file uses only fenced code blocks (```), the import is not required. Apply this guideline to all MDX files (e.g., src/content/docs/**/*.mdx) to avoid unnecessary imports and reduce bundle size.

Applied to files:

  • src/components/templates/coding-agents/_scim-claude-code.mdx
  • src/content/docs/authenticate/mcp/quickstart.mdx
  • src/content/docs/sso/quickstart.mdx
  • src/content/docs/authenticate/fsa/quickstart.mdx
  • src/content/docs/home/saaskit/index.mdx
  • src/content/docs/passwordless/quickstart.mdx
  • src/content/docs/passwordless/oidc.mdx
  • src/content/docs/directory/scim/quickstart.mdx
  • src/components/templates/coding-agents/_fsa-claude-code.mdx
  • src/components/templates/coding-agents/_mcp-auth-claude-code.mdx
  • src/components/templates/coding-agents/_agentkit-claude-code.mdx
  • src/components/templates/coding-agents/_sso-claude-code.mdx
  • src/content/docs/authenticate/sso/add-modular-sso.mdx
📚 Learning: 2026-02-25T18:41:00.639Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 446
File: src/content/docs/authenticate/m2m/api-auth-quickstart.mdx:78-78
Timestamp: 2026-02-25T18:41:00.639Z
Learning: Preserve full URLs inside code comments in MDX code blocks (bash/python/js) when the URLs are part of copyable examples. Do not flag these in code examples. Use relative paths in prose and hyperlinks within MDX; only enforce relative paths for markdown prose links, not for URLs inside code comments.

Applied to files:

  • src/components/templates/coding-agents/_scim-claude-code.mdx
  • src/content/docs/authenticate/mcp/quickstart.mdx
  • src/content/docs/sso/quickstart.mdx
  • src/content/docs/authenticate/fsa/quickstart.mdx
  • src/content/docs/home/saaskit/index.mdx
  • src/content/docs/passwordless/quickstart.mdx
  • src/content/docs/passwordless/oidc.mdx
  • src/content/docs/directory/scim/quickstart.mdx
  • src/components/templates/coding-agents/_fsa-claude-code.mdx
  • src/components/templates/coding-agents/_mcp-auth-claude-code.mdx
  • src/components/templates/coding-agents/_agentkit-claude-code.mdx
  • src/components/templates/coding-agents/_sso-claude-code.mdx
  • src/content/docs/authenticate/sso/add-modular-sso.mdx
📚 Learning: 2026-04-25T07:22:18.321Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 633
File: src/components/templates/agent-connectors/_setup-heyreach.mdx:12-12
Timestamp: 2026-04-25T07:22:18.321Z
Learning: In this repo’s MDX documentation files, treat `@/...` paths as aliases that resolve to the `src/` directory (e.g., `@/assets/docs/foo/bar.png` -> `src/assets/docs/foo/bar.png`). When reviewing, do not flag `@`-prefixed image (or other asset) paths as broken; instead, verify that the corresponding physical file exists under `src/`.

Applied to files:

  • src/components/templates/coding-agents/_scim-claude-code.mdx
  • src/content/docs/authenticate/mcp/quickstart.mdx
  • src/content/docs/sso/quickstart.mdx
  • src/content/docs/authenticate/fsa/quickstart.mdx
  • src/content/docs/home/saaskit/index.mdx
  • src/content/docs/passwordless/quickstart.mdx
  • src/content/docs/passwordless/oidc.mdx
  • src/content/docs/directory/scim/quickstart.mdx
  • src/components/templates/coding-agents/_fsa-claude-code.mdx
  • src/components/templates/coding-agents/_mcp-auth-claude-code.mdx
  • src/components/templates/coding-agents/_agentkit-claude-code.mdx
  • src/components/templates/coding-agents/_sso-claude-code.mdx
  • src/content/docs/authenticate/sso/add-modular-sso.mdx
📚 Learning: 2026-01-30T18:18:50.883Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 415
File: src/content/docs/authenticate/fsa/multiapp/manage-apps.mdx:31-49
Timestamp: 2026-01-30T18:18:50.883Z
Learning: In all Scalekit documentation files (MDX), treat the terms 'Applications', 'Single Page Application (SPA)', 'Native Application', and 'Web Application' as proper nouns and preserve their capitalization in headings and body text. Ensure these terms remain capitalized even when used in sentence case or within prose.

Applied to files:

  • src/content/docs/authenticate/mcp/quickstart.mdx
  • src/content/docs/sso/quickstart.mdx
  • src/content/docs/authenticate/fsa/quickstart.mdx
  • src/content/docs/home/saaskit/index.mdx
  • src/content/docs/passwordless/quickstart.mdx
  • src/content/docs/passwordless/oidc.mdx
  • src/content/docs/directory/scim/quickstart.mdx
  • src/content/docs/authenticate/sso/add-modular-sso.mdx
📚 Learning: 2026-02-04T12:47:16.544Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 412
File: src/content/docs/dev-kit/tools/scalekit-dryrun.mdx:1-23
Timestamp: 2026-02-04T12:47:16.544Z
Learning: In scalekit-inc/developer-docs, the MDX frontmatter field order is required only when the sidebar configuration points to a directory (for auto-generation). If the sidebar.config.ts references a specific file path, the order field is not required. Apply this check to all MDX files under src/content/docs: if a file contributes to an auto-generated sidebar (directory path), ensure order is present; if it’s linked to a concrete file, order can be omitted. Use sidebar.config.ts to determine whether a given MDX file falls under directory-based vs file-specific sidebar references.

Applied to files:

  • src/content/docs/authenticate/mcp/quickstart.mdx
  • src/content/docs/sso/quickstart.mdx
  • src/content/docs/authenticate/fsa/quickstart.mdx
  • src/content/docs/home/saaskit/index.mdx
  • src/content/docs/passwordless/quickstart.mdx
  • src/content/docs/passwordless/oidc.mdx
  • src/content/docs/directory/scim/quickstart.mdx
  • src/content/docs/authenticate/sso/add-modular-sso.mdx
📚 Learning: 2026-02-25T08:57:12.201Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 444
File: src/content/docs/agent-auth/quickstart.mdx:2-10
Timestamp: 2026-02-25T08:57:12.201Z
Learning: In Scalekit developer-docs (Astro Starlight), do not auto-suggest adding tableOfContents in frontmatter unless the user explicitly overrides the default behavior. The default enables tableOfContents with minHeadingLevel 2 and maxHeadingLevel 3. Only set tableOfContents when you want to customize heading levels or disable it entirely; otherwise omit it for other docs.

Applied to files:

  • src/content/docs/authenticate/mcp/quickstart.mdx
  • src/content/docs/sso/quickstart.mdx
  • src/content/docs/authenticate/fsa/quickstart.mdx
  • src/content/docs/home/saaskit/index.mdx
  • src/content/docs/passwordless/quickstart.mdx
  • src/content/docs/passwordless/oidc.mdx
  • src/content/docs/directory/scim/quickstart.mdx
  • src/content/docs/authenticate/sso/add-modular-sso.mdx
📚 Learning: 2026-02-25T13:04:27.491Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 444
File: src/content/docs/agent-auth/start-agent-auth-coding-agents.mdx:9-17
Timestamp: 2026-02-25T13:04:27.491Z
Learning: Allow page-level CSS overrides in MDX frontmatter (head: style) for readability and engagement, even if it customizes typography beyond defaults. This applies to per-page UX decisions, including heading sizes and style tweaks, but keep overrides purposeful, accessible, and within the repository's design guidelines. Use these overrides sparingly and document the rationale for maintainability.

Applied to files:

  • src/content/docs/authenticate/mcp/quickstart.mdx
  • src/content/docs/sso/quickstart.mdx
  • src/content/docs/authenticate/fsa/quickstart.mdx
  • src/content/docs/home/saaskit/index.mdx
  • src/content/docs/passwordless/quickstart.mdx
  • src/content/docs/passwordless/oidc.mdx
  • src/content/docs/directory/scim/quickstart.mdx
  • src/content/docs/authenticate/sso/add-modular-sso.mdx
📚 Learning: 2026-03-05T11:29:08.125Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 463
File: src/content/docs/agent-auth/providers.mdx:35-73
Timestamp: 2026-03-05T11:29:08.125Z
Learning: In src/content/docs/agent-auth/providers.mdx, the Card components intentionally use icon=" " (a space) to render consistent colored boxes since some Starlight icon names resolve to icons and others do not. Do not flag icon=" " as a placeholder issue for this file; treat this as a deliberate UX choice specific to this MDX page and avoid raising a placeholder-icon warning here.

Applied to files:

  • src/content/docs/authenticate/mcp/quickstart.mdx
  • src/content/docs/sso/quickstart.mdx
  • src/content/docs/authenticate/fsa/quickstart.mdx
  • src/content/docs/home/saaskit/index.mdx
  • src/content/docs/passwordless/quickstart.mdx
  • src/content/docs/passwordless/oidc.mdx
  • src/content/docs/directory/scim/quickstart.mdx
  • src/content/docs/authenticate/sso/add-modular-sso.mdx
📚 Learning: 2026-03-09T07:27:56.794Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 469
File: src/content/docs/guides/integrations/scim-integrations/azure-scim.mdx:95-107
Timestamp: 2026-03-09T07:27:56.794Z
Learning: Do not enforce the 3-space indentation rule for Steps component content as a hard style rule in MDX files under src/content/docs/**/*.mdx. Only flag/rectify it if it causes visible rendering problems in the UI. Otherwise, allow current formatting; apply this rule only when rendering issues are observed and document any fixes.

Applied to files:

  • src/content/docs/authenticate/mcp/quickstart.mdx
  • src/content/docs/sso/quickstart.mdx
  • src/content/docs/authenticate/fsa/quickstart.mdx
  • src/content/docs/home/saaskit/index.mdx
  • src/content/docs/passwordless/quickstart.mdx
  • src/content/docs/passwordless/oidc.mdx
  • src/content/docs/directory/scim/quickstart.mdx
  • src/content/docs/authenticate/sso/add-modular-sso.mdx
📚 Learning: 2026-03-09T07:32:38.426Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 467
File: src/content/docs/sso/guides/sso-user-attributes.mdx:108-148
Timestamp: 2026-03-09T07:32:38.426Z
Learning: In MDX code samples under src/content/docs (and similar conceptual snippets in scalekit-inc/developer-docs), when an example's sole purpose is to show how to access a specific value (e.g., reading JWT claims after token validation), omit error/non-happy-path handling to keep the snippet focused. Do not flag the absence of error paths in narrowly scoped conceptual snippets.

Applied to files:

  • src/content/docs/authenticate/mcp/quickstart.mdx
  • src/content/docs/sso/quickstart.mdx
  • src/content/docs/authenticate/fsa/quickstart.mdx
  • src/content/docs/home/saaskit/index.mdx
  • src/content/docs/passwordless/quickstart.mdx
  • src/content/docs/passwordless/oidc.mdx
  • src/content/docs/directory/scim/quickstart.mdx
  • src/content/docs/authenticate/sso/add-modular-sso.mdx
📚 Learning: 2026-03-17T16:01:50.487Z
Learnt from: dhaneshbs
Repo: scalekit-inc/developer-docs PR: 506
File: src/content/docs/authenticate/fsa/quickstart.mdx:851-853
Timestamp: 2026-03-17T16:01:50.487Z
Learning: In the Scalekit Python SDK docs, clarify that LogoutUrlOptions is not exported from the top-level scalekit package __init__.py. The correct import path in code samples or reviews is: from scalekit.common.scalekit import LogoutUrlOptions. Do not flag this import path as incorrect in documentation or code reviews; ensure examples reflect the proper import path to avoid confusion for users.

Applied to files:

  • src/content/docs/authenticate/mcp/quickstart.mdx
  • src/content/docs/sso/quickstart.mdx
  • src/content/docs/authenticate/fsa/quickstart.mdx
  • src/content/docs/home/saaskit/index.mdx
  • src/content/docs/passwordless/quickstart.mdx
  • src/content/docs/passwordless/oidc.mdx
  • src/content/docs/directory/scim/quickstart.mdx
  • src/content/docs/authenticate/sso/add-modular-sso.mdx
🪛 LanguageTool
src/components/templates/coding-agents/_fsa-claude-code.mdx

[uncategorized] ~9-~9: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...it's plugin marketplace and install the Full Stack Auth plugin in a single command: ``...

(EN_COMPOUND_ADJECTIVE_INTERNAL)

🔇 Additional comments (15)
src/configs/agent-instructions.ts (1)

12-12: Consistent single-command rollout across all agent instruction variants

The Claude Code command is updated uniformly in every exported instruction string, which prevents drift between prompt/header/meta surfaces.

Also applies to: 35-35, 53-53, 81-81, 109-109

src/content/docs/passwordless/quickstart.mdx (1)

92-94: Claude Code setup block looks good

The consolidated terminal command is clear and consistent with the updated install flow.

public/AGENTS.md (1)

11-13: Fenced Claude command update is correct

Good switch to a single bash snippet with the consolidated install command.

src/content/docs/authenticate/fsa/quickstart.mdx (1)

83-85: Claude install step is now consistent and clear

The single chained command aligns with the consolidated install pattern.

src/content/docs/directory/scim/quickstart.mdx (1)

103-105: SCIM Claude command update is correct

The merged command is accurate and keeps this quickstart aligned with the new installation pattern.

src/content/docs/authenticate/sso/add-modular-sso.mdx (1)

72-74: Modular SSO Claude install snippet looks good

The consolidated command is clear and consistent with the updated flow.

src/content/docs/passwordless/oidc.mdx (1)

80-82: Passwordless OIDC Claude setup update is solid

The one-line command sequence is consistent and easier to follow.

src/content/docs/home/saaskit/index.mdx (1)

205-208: Homepage Claude install command is aligned

Nice update to the consolidated command flow in the main SaaSKit entry page.

src/content/docs/sso/quickstart.mdx (1)

121-123: Single-command Claude setup is clear and consistent.

This update matches the consolidated install flow and reduces setup friction without changing intent.

src/content/docs/authenticate/mcp/quickstart.mdx (1)

55-57: Consolidated Claude command looks good.

The one-line marketplace+install flow is easier to copy/paste and remains consistent with the rest of the page.

src/components/templates/coding-agents/_mcp-auth-claude-code.mdx (1)

8-16: Step flow and command consolidation are correctly applied.

The updated sequence improves readability and keeps the setup path consistent with other Claude Code templates.

Also applies to: 45-67

src/components/templates/coding-agents/_agentkit-claude-code.mdx (1)

4-12: Install/update flow is well-structured and consistent.

The consolidated command and step renumbering make the guide easier to follow end-to-end.

Also applies to: 33-50

src/components/templates/coding-agents/_fsa-claude-code.mdx (1)

5-13: FSA template update is solid.

The command consolidation and step numbering update are consistent and clear for users following the flow.

Also applies to: 34-50

src/components/templates/coding-agents/_scim-claude-code.mdx (1)

5-13: SCIM template changes are clean and consistent.

The install command consolidation and step renumbering improve usability without altering workflow semantics.

Also applies to: 34-50

src/components/templates/coding-agents/_sso-claude-code.mdx (1)

5-13: SSO template update looks good.

The single CLI command and reordered steps keep this template aligned with the broader docs update.

Also applies to: 34-50


Walkthrough

The Claude Code terminal installation snippets were consolidated from REPL-style two-step commands into single Terminal claude plugin marketplace add ... && claude plugin install ... command sequences across documentation, coding-agent templates, AGENTS.md, and agent instruction strings; related step headings were renumbered.

Changes

Claude Code Installation Instructions

Layer / File(s) Summary
Terminal installation snippet changes
src/content/docs/dev-kit/build-with-ai/index.mdx, public/AGENTS.md, src/components/templates/coding-agents/*, src/content/docs/*
Replaced REPL-style /plugin ... or multi-step snippets with single-line Terminal/bash claude plugin marketplace add ... && claude plugin install ... commands across docs and templates.
Template step renumbering
src/components/templates/coding-agents/_agentkit-claude-code.mdx, _fsa-claude-code.mdx, _mcp-auth-claude-code.mdx, _scim-claude-code.mdx, _sso-claude-code.mdx
Adjusted step/section headings so subsequent steps are renumbered after the consolidated Step 1 content.
Agent instruction string updates
src/configs/agent-instructions.ts
Updated exported agent-facing strings (AGENT_PLUGIN_HEADER, AGENT_PLUGIN_INLINE, AGENT_PLUGIN_DETAILS_MD, AGENT_PLUGIN_VISIBLE_MD, AGENT_PLUGIN_META) to use the single-line Terminal installation command.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

Suggested reviewers

  • ravibits
  • amitash1912
  • dhaneshbs
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch update/build-with-ai-page
  • 🛠️ fix frontmatter
  • 🛠️ fix internal links

@netlify
Copy link
Copy Markdown

netlify Bot commented May 12, 2026

Deploy Preview for scalekit-starlight ready!

Name Link
🔨 Latest commit 21bec21
🔍 Latest deploy log https://app.netlify.com/projects/scalekit-starlight/deploys/6a03486af9627900081fffd5
😎 Deploy Preview https://deploy-preview-683--scalekit-starlight.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant