docs: Update README with agent-first positioning#165
Open
saif-at-scalekit wants to merge 7 commits into
Open
Conversation
saif-at-scalekit
requested review from
dhaneshbs and
srinivaskarre-sk
as code owners
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
WalkthroughRewrites Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (3)
README.md (3)
144-144: Standardize title capitalization.Minor inconsistency: "setup Guide" should use title case like the other link descriptions.
✨ Suggested polish
-- [setup Guide](https://docs.scalekit.com/guides/setup-scalekit/) — initial platform configuration +- [Setup Guide](https://docs.scalekit.com/guides/setup-scalekit/) — initial platform configuration🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` at line 144, Change the link description text "setup Guide" to use title case to match the other entries — replace it with "Setup Guide" in the README where the link text appears (the markdown line containing "[setup Guide](https://docs.scalekit.com/guides/setup-scalekit/) — initial platform configuration").
28-28: Standardize acronym capitalization.Technical acronyms should use consistent uppercase formatting. "Mcp" should be "MCP" (Model Context Protocol) and "Dcr/pkce" should be "DCR/PKCE" (Dynamic Client Registration/Proof Key for Code Exchange).
📝 Proposed fix
-- **Mcp-Native OAuth 2.1** — Purpose-built for Model Context Protocol with Dcr/pkce support +- **MCP-Native OAuth 2.1** — Purpose-built for Model Context Protocol with DCR/PKCE support🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` at line 28, Update the acronym capitalization in the README phrase: replace "Mcp" with "MCP" in the heading "Mcp-Native OAuth 2.1" and replace "Dcr/pkce" with "DCR/PKCE" so the text reads "MCP-Native OAuth 2.1 — Purpose-built for Model Context Protocol with DCR/PKCE support"; adjust only those tokens to preserve the rest of the line.
33-39: Standardize feature list capitalization.The feature descriptions use inconsistent capitalization. Apply title case consistently and use uppercase for acronyms.
📝 Proposed fix for consistent formatting
#### Human Authentication - **Enterprise SSO** — support for SAML and OIDC protocols -- **scim Provisioning** — automated user provisioning and deprovisioning -- **passwordless Authentication** — magic links, OTP, and modern auth flows -- **multi-tenant Architecture** — organization-level authentication policies -- **social Logins** — support for popular social identity providers -- **full-Stack Auth** — complete IdP-of-record solution for B2B SaaS +- **SCIM Provisioning** — automated user provisioning and deprovisioning +- **Passwordless Authentication** — magic links, OTP, and modern auth flows +- **Multi-Tenant Architecture** — organization-level authentication policies +- **Social Logins** — support for popular social identity providers +- **Full-Stack Auth** — complete IdP-of-record solution for B2B SaaS🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` around lines 33 - 39, Update the "Human Authentication" feature list to use consistent title case and uppercase acronyms: change bullets under the "Human Authentication" header so each feature starts with capitalized words (e.g., "Enterprise SSO", "SCIM Provisioning", "Passwordless Authentication", "Multi-Tenant Architecture", "Social Logins", "Full-Stack Auth") and ensure acronyms like SSO, OIDC, SCIM, OTP, and IdP are uppercase; adjust wording where needed to maintain parallel structure across items.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Line 5: The logo image tag in the README is missing an alt attribute; update
the <img> element to include meaningful alternative text (e.g., alt="ScaleKit
logo" or a more descriptive phrase) so screen readers and image-fallback
scenarios have accessible content; ensure the alt text succinctly describes the
logo and matches the brand/context.
- Around line 126-130: The table row for "**Auth.js** |
[scalekit-authjs-example](https://github.com/scalekit-developers/scalekit-authjs-example)
| Next.js with Auth.js (next-auth v5)" is incorrectly indented and being
rendered as a code block; fix it by removing the leading spaces so the row
begins with a pipe (|) and uses the same three-column pipe-separated format as
the other rows, ensuring alignment with the header and other rows in README.md.
---
Nitpick comments:
In `@README.md`:
- Line 144: Change the link description text "setup Guide" to use title case to
match the other entries — replace it with "Setup Guide" in the README where the
link text appears (the markdown line containing "[setup
Guide](https://docs.scalekit.com/guides/setup-scalekit/) — initial platform
configuration").
- Line 28: Update the acronym capitalization in the README phrase: replace "Mcp"
with "MCP" in the heading "Mcp-Native OAuth 2.1" and replace "Dcr/pkce" with
"DCR/PKCE" so the text reads "MCP-Native OAuth 2.1 — Purpose-built for Model
Context Protocol with DCR/PKCE support"; adjust only those tokens to preserve
the rest of the line.
- Around line 33-39: Update the "Human Authentication" feature list to use
consistent title case and uppercase acronyms: change bullets under the "Human
Authentication" header so each feature starts with capitalized words (e.g.,
"Enterprise SSO", "SCIM Provisioning", "Passwordless Authentication",
"Multi-Tenant Architecture", "Social Logins", "Full-Stack Auth") and ensure
acronyms like SSO, OIDC, SCIM, OTP, and IdP are uppercase; adjust wording where
needed to maintain parallel structure across items.
🪄 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: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 272ddf46-1b06-461a-abc8-7712917e508d
⛔ Files ignored due to path filters (1)
scalekit-logo.svgis excluded by!**/*.svg
📒 Files selected for processing (1)
README.md
- Refactor README structure for better readability - Add agent-first features section ahead of human auth - Update messaging to emphasize 'auth stack for agents' positioning - Add scalekit-logo.svg asset for consistent branding - Improve documentation links and quick start section - Align features description with current capabilities
saif-at-scalekit
force-pushed
the
docs/update-readme-agent-first
branch
from
d2032cb to
2b56ffc
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
README.md (1)
126-130:⚠️ Potential issue | 🟡 MinorFix broken table row rendering for the Auth.js entry.
Line 130 is still indented and missing the leading
|, so it renders as code instead of a table row.🔧 Proposed fix
| Framework | Repository | Description | |-----------|------------|-------------| | **Express.js** | [scalekit-express-example](https://github.com/scalekit-developers/scalekit-express-example) | Basic Express.js server implementation | | **Next.js** | [scalekit-nextjs-demo](https://github.com/scalekit-developers/scalekit-nextjs-demo) | Modern React/Next.js application | - **Auth.js** | [scalekit-authjs-example](https://github.com/scalekit-developers/scalekit-authjs-example) | Next.js with Auth.js (next-auth v5) | +| **Auth.js** | [scalekit-authjs-example](https://github.com/scalekit-developers/scalekit-authjs-example) | Next.js with Auth.js (next-auth v5) |🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` around lines 126 - 130, The Auth.js table row is indented and missing the leading '|' so it renders as code; fix the row (the line containing "**Auth.js** | [scalekit-authjs-example](https://github.com/scalekit-developers/scalekit-authjs-example) | Next.js with Auth.js (next-auth v5)") by removing the leading indentation and adding the leading pipe so it becomes a proper table row like the others: | **Auth.js** | [scalekit-authjs-example](https://github.com/scalekit-developers/scalekit-authjs-example) | Next.js with Auth.js (next-auth v5) |
🧹 Nitpick comments (1)
README.md (1)
33-39: Normalize capitalization for headings and feature names.There’s mixed casing (
installation,scim Provisioning,passwordless Authentication,setup Guide) that reduces consistency in docs.🧹 Suggested cleanup
-#### installation +#### Installation -- **scim Provisioning** — automated user provisioning and deprovisioning -- **passwordless Authentication** — magic links, OTP, and modern auth flows -- **multi-tenant Architecture** — organization-level authentication policies -- **social Logins** — support for popular social identity providers -- **full-Stack Auth** — complete IdP-of-record solution for B2B SaaS +- **SCIM Provisioning** — automated user provisioning and deprovisioning +- **Passwordless Authentication** — magic links, OTP, and modern auth flows +- **Multi-tenant Architecture** — organization-level authentication policies +- **Social Logins** — support for popular social identity providers +- **Full-stack Auth** — complete IdP-of-record solution for B2B SaaS -- [setup Guide](https://docs.scalekit.com/guides/setup-scalekit/) — initial platform configuration +- [Setup Guide](https://docs.scalekit.com/guides/setup-scalekit/) — initial platform configurationAlso applies to: 45-45, 144-144
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` around lines 33 - 39, Normalize heading and feature-name capitalization to a consistent style (use Title Case) across the README: update the heading "Human Authentication" and each bullet so they use Title Case and correct acronyms/casing — e.g., change "scim Provisioning" to "SCIM Provisioning", "passwordless Authentication" to "Passwordless Authentication", "multi-tenant Architecture" to "Multi-Tenant Architecture", "social Logins" to "Social Logins", and "full-Stack Auth" to "Full-Stack Auth"; also scan and fix other headings/features like "installation" and "setup Guide" to "Installation" and "Setup Guide" to keep consistency.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Line 24: The opening sentence contains an extra comma before the em dash in
the phrase "Scalekit), —"; remove that stray comma so it reads "Scalekit) — the
auth stack for agents" (update the string in README.md that contains "This is
the official Node.js SDK for [Scalekit](https://scalekit.com), — the auth stack
for agents" to the corrected punctuation).
---
Duplicate comments:
In `@README.md`:
- Around line 126-130: The Auth.js table row is indented and missing the leading
'|' so it renders as code; fix the row (the line containing "**Auth.js** |
[scalekit-authjs-example](https://github.com/scalekit-developers/scalekit-authjs-example)
| Next.js with Auth.js (next-auth v5)") by removing the leading indentation and
adding the leading pipe so it becomes a proper table row like the others: |
**Auth.js** |
[scalekit-authjs-example](https://github.com/scalekit-developers/scalekit-authjs-example)
| Next.js with Auth.js (next-auth v5) |
---
Nitpick comments:
In `@README.md`:
- Around line 33-39: Normalize heading and feature-name capitalization to a
consistent style (use Title Case) across the README: update the heading "Human
Authentication" and each bullet so they use Title Case and correct
acronyms/casing — e.g., change "scim Provisioning" to "SCIM Provisioning",
"passwordless Authentication" to "Passwordless Authentication", "multi-tenant
Architecture" to "Multi-Tenant Architecture", "social Logins" to "Social
Logins", and "full-Stack Auth" to "Full-Stack Auth"; also scan and fix other
headings/features like "installation" and "setup Guide" to "Installation" and
"Setup Guide" to keep consistency.
🪄 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: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 35870656-0c62-42ff-b7cc-34fdc3bfed45
⛔ Files ignored due to path filters (2)
images/scalekit.jpgis excluded by!**/*.jpgscalekit-logo.svgis excluded by!**/*.svg
📒 Files selected for processing (1)
README.md
dhaneshbs
approved these changes
Mar 31, 2026
Contributor
Author
|
@coderabbitai please approve |
|
Tip For best results, initiate chat on the files or code changes.
[approve] |
There was a problem hiding this comment.
Actionable comments posted: 3
♻️ Duplicate comments (1)
README.md (1)
24-24:⚠️ Potential issue | 🟡 MinorFix punctuation: remove extra comma before em dash.
The extra comma in "Scalekit](https://scalekit.com), —" creates awkward punctuation. This issue was flagged in a previous review but remains unresolved.
Additionally, "Mcp" should be capitalized as "MCP" (Model Context Protocol).
✏️ Proposed fix
-This is the official Node.js SDK for [Scalekit](https://scalekit.com), — the auth stack for agents. Build secure AI products faster with authentication for humans (SSO, passwordless, full-stack auth) and agents (Mcp/APIs, delegated actions), all unified on one platform. +This is the official Node.js SDK for [Scalekit](https://scalekit.com) — the auth stack for agents. Build secure AI products faster with authentication for humans (SSO, passwordless, full-stack auth) and agents (MCP/APIs, delegated actions), all unified on one platform.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` at line 24, The README sentence contains incorrect punctuation and casing: remove the extra comma before the em dash in the fragment "Scalekit](https://scalekit.com), —" so it reads "Scalekit](https://scalekit.com) —", and change "Mcp" to uppercase "MCP" (the fragment "Mcp/APIs" should become "MCP/APIs") to correct the protocol name and punctuation.
🧹 Nitpick comments (1)
README.md (1)
126-130: Table formatting issue from previous review is resolved.The Auth.js row is now properly formatted with pipe separators. The static analysis tool suggests adding blank lines around the table for consistency with Markdown linting standards, but this is optional.
📝 Optional: Add blank lines for linting compliance
});
Framework Repository Description Express.js scalekit-express-example Basic Express.js server implementation Next.js scalekit-nextjs-demo Modern React/Next.js application Auth.js scalekit-authjs-example Next.js with Auth.js (next-auth v5)
</details> <details> <summary>🤖 Prompt for AI Agents</summary>Verify each finding against the current code and only fix it if needed.
In
@README.mdaround lines 126 - 130, Add a blank line immediately before the
table header row "| Framework | Repository | Description |" and another blank
line immediately after the last table row ("| Auth.js |
scalekit-authjs-example
| Next.js with Auth.js (next-auth v5) |") so the Markdown table is surrounded by
empty lines for linting compliance; do not change the table content or
formatting of those rows.</details> </blockquote></details> </blockquote></details> <details> <summary>🤖 Prompt for all review comments with AI agents</summary>Verify each finding against the current code and only fix it if needed.
Inline comments:
In@README.md:
- Line 144: Update the link label text "[setup Guide]" to use title case to
match other headings: change it to "[Setup Guide]" in the README (replace the
existing "setup Guide —
initial platform configuration" line). Ensure only the displayed link text is
changed, leaving the URL unchanged.- Line 28: Update the README phrase "Mcp-Native OAuth 2.1" to use proper
capitalization and acronym forms: replace "Mcp-Native OAuth 2.1" with
"MCP-Native OAuth 2.1" and change "Dcr/pkce" to "DCR/PKCE" so the line reads
like "MCP-Native OAuth 2.1 — Purpose-built for Model Context Protocol with
DCR/PKCE support".- Around line 35-39: Standardize the capitalization in the Human Authentication
feature list by capitalizing the first word of each bullet; update "scim
Provisioning" → "Scim Provisioning", "passwordless Authentication" →
"Passwordless Authentication", "multi-tenant Architecture" → "Multi-tenant
Architecture", "social Logins" → "Social Logins", and "full-Stack Auth" →
"Full-Stack Auth" so all feature names follow the same first-word capitalization
pattern.
Duplicate comments:
In@README.md:
- Line 24: The README sentence contains incorrect punctuation and casing: remove
the extra comma before the em dash in the fragment
"Scalekit](https://scalekit.com), —" so it reads
"Scalekit](https://scalekit.com) —", and change "Mcp" to uppercase "MCP" (the
fragment "Mcp/APIs" should become "MCP/APIs") to correct the protocol name and
punctuation.
Nitpick comments:
In@README.md:
- Around line 126-130: Add a blank line immediately before the table header row
"| Framework | Repository | Description |" and another blank line immediately
after the last table row ("| Auth.js |
scalekit-authjs-example
| Next.js with Auth.js (next-auth v5) |") so the Markdown table is surrounded by
empty lines for linting compliance; do not change the table content or
formatting of those rows.</details> <details> <summary>🪄 Autofix (Beta)</summary> Fix all unresolved CodeRabbit comments on this PR: - [ ] <!-- {"checkboxId": "4b0d0e0a-96d7-4f10-b296-3a18ea78f0b9"} --> Push a commit to this branch (recommended) - [ ] <!-- {"checkboxId": "ff5b1114-7d8c-49e6-8ac1-43f82af23a33"} --> Create a new PR with the fixes </details> --- <details> <summary>ℹ️ Review info</summary> <details> <summary>⚙️ Run configuration</summary> **Configuration used**: Organization UI **Review profile**: CHILL **Plan**: Pro **Run ID**: `6224649f-76d2-49c3-b7ae-896a3a0c21c8` </details> <details> <summary>📥 Commits</summary> Reviewing files that changed from the base of the PR and between 2b56ffc5c4da570f8e6b37faf19994f45566bc29 and c743af05b04b33eefe8977d5386706a2d64f6d25. </details> <details> <summary>📒 Files selected for processing (1)</summary> * `README.md` </details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (2)
README.md (2)
45-45: Capitalize heading for consistency.The "installation" heading should be capitalized to match the style of other headings in this section ("Prerequisites" and "Usage").
✏️ Proposed fix
-#### installation +#### Installation🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` at line 45, The heading "installation" should be capitalized for consistency with other headings; locate the markdown heading text "installation" (the line starting with "#### installation") and change it to "#### Installation" so it matches the style of "Prerequisites" and "Usage".
143-143: Capitalize subheading for consistency.The "Additional resources" subheading should use title case to match other subheadings in this section ("Quickstart Guides" and "Documentation & Reference").
✏️ Proposed fix
-#### Additional resources +#### Additional Resources🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` at line 143, Change the "Additional resources" subheading to title case to match other headings: locate the heading string "Additional resources" in README.md and update it to "Additional Resources" so it is consistent with "Quickstart Guides" and "Documentation & Reference".
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Line 24: Update the acronym "Mcp/APIs" to "MCP/APIs" in the README text (the
string containing "Mcp/APIs") to properly capitalize the Model Context Protocol
acronym; locate the line with that phrase and replace it so the sentence reads
"...agents (MCP/APIs, delegated actions)..." with the corrected capitalization.
- Line 135: Update the README line that describes the auth solution (the link
text "Full Stack Auth" / its description) so the technical term is capitalized
as "Single Sign-On" (capitalize the "O" in "On") instead of any lowercase
variant; locate the phrase in the README and replace it accordingly.
---
Nitpick comments:
In `@README.md`:
- Line 45: The heading "installation" should be capitalized for consistency with
other headings; locate the markdown heading text "installation" (the line
starting with "#### installation") and change it to "#### Installation" so it
matches the style of "Prerequisites" and "Usage".
- Line 143: Change the "Additional resources" subheading to title case to match
other headings: locate the heading string "Additional resources" in README.md
and update it to "Additional Resources" so it is consistent with "Quickstart
Guides" and "Documentation & Reference".
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
- Line 24: MCP/APIs (was Mcp/APIs) - Line 45: Installation heading (was installation) - Line 134: Single Sign-On (was Single Sign-on) - Line 143: Additional Resources heading (was Additional resources) Addresses CodeRabbit review comments for PR #165.
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Line 24: The sentence in README.md contains redundant punctuation "..., —" —
remove the comma before the em dash so it reads either with a comma or with the
em dash; update the sentence starting "This is the official Node.js SDK for
Scalekit" by deleting the comma that precedes the em dash to produce correct
punctuation.
- Around line 126-130: The markdown table block starting with the header line "|
Framework | Repository | Description |" needs blank lines immediately before and
after it for proper rendering; update README.md by inserting a single empty line
above that header and another empty line after the last table row ("|
**Auth.js** |
[scalekit-authjs-example](https://github.com/scalekit-developers/scalekit-authjs-example)
| Next.js with Auth.js (next-auth v5) |") so the table is separated from
surrounding content and follows Markdown conventions.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
…cing
- Line 24: Remove comma before em dash (', —' → ' —')
- Lines 126-130: Add blank line before and after markdown table for proper rendering
Addresses additional CodeRabbit review comments for PR #165.
- Line 129: removeOrganizationClientSecret (was deleteOrganizationClientSecret) - Aligns test with actual SDK method names (add/remove, not create/delete)
srinivaskarre-sk
approved these changes
Apr 15, 2026
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.
Updates the README with improved structure and agent-first messaging:
Summary by CodeRabbit