fix: Overhaul of Get Started guide pages#725
Conversation
|
Warning Rate limit exceeded
To keep reviews running without waiting, you can enable usage-based add-on for your organization. This allows additional reviews beyond the hourly cap. Account admins can enable it under billing. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Repository UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (3)
WalkthroughThree "Get started" guides were restructured: onboarding flows and content expanded (byo-code, first-things-first, set-up-tasks) and sidebar navigation switched from autogenerated to an explicit list of guide entries. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 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 |
Deploying kinde-docs-preview with
|
| Latest commit: |
babaa71
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://42e831ef.kinde-docs-preview.pages.dev |
| Branch Preview URL: | https://tamal-update-onboarding-for.kinde-docs-preview.pages.dev |
tamalchowdhury
changed the title
![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)
src/content/docs/get-started/guides/byo-code.mdx (1)
80-80: Nit: double space.
head over to our [SDK page]has two spaces before the link.Proposed fix
- If you are unsure about which application type to select, head over to our [SDK page](/developer-tools/about/our-sdks/) and find the language or framework you are using. For backend/fullstack apps, select **Back-end web**. For client-side apps like web and mobile, select **Front end and mobile**. + If you are unsure about which application type to select, head over to our [SDK page](/developer-tools/about/our-sdks/) and find the language or framework you are using. For backend/fullstack apps, select **Back-end web**. For client-side apps like web and mobile, select **Front end and mobile**.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/content/docs/get-started/guides/byo-code.mdx` at line 80, The sentence contains an accidental double space in the markdown link text ("head over to our [SDK page]"); locate that exact string in src/content/docs/get-started/guides/byo-code.mdx and remove the extra space so it reads "head over to our [SDK page]" (ensure only a single space before the link and preserve surrounding punctuation and capitalization).src/content/docs/get-started/guides/first-things-first.mdx (1)
154-154: Nit: align pricing URL across guides.This page links to
https://www.kinde.com/pricing/, whileset-up-tasks.mdx(line 145) andbyo-code.mdxusehttps://kinde.com/pricing/. Both work, but pick one for consistency across the get-started guides.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/content/docs/get-started/guides/first-things-first.mdx` at line 154, Replace the pricing URL in the sentence currently using "https://www.kinde.com/pricing/" with the canonical "https://kinde.com/pricing/" so it matches the links used in set-up-tasks.mdx and byo-code.mdx; search for occurrences of both "https://www.kinde.com/pricing/" and "https://kinde.com/pricing/" across the get-started guides and normalize them to "https://kinde.com/pricing/" (update the text in first-things-first.mdx where that URL appears).src/data/sidebarData.ts (1)
12-21: Heads up: this section will no longer auto-pick up new guides.Switching
Guidesfromautogenerateto a hardcodeditemslist is fine for the curated set, but any new file added undersrc/content/docs/get-started/guides/won't appear in the sidebar unless someone updates this list as well. Consider adding a brief comment here as a reminder for future contributors.Also note that
byo-code.mdxandset-up-tasks.mdxboth still declaresidebar.order: 2in frontmatter; with the hardcoded list, those values are now decorative/stale. You may want to drop theorderkey (or set distinct values) so they don't mislead future maintainers.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/data/sidebarData.ts` around lines 12 - 21, Summary: The "Guides" sidebar entry was converted from autogenerate to a hardcoded items array so new guide files won't appear automatically. Edit the sidebar object with label "Guides" (the object that currently contains an items array) and add a short inline comment above or beside it noting that this is a curated list and new files under src/content/docs/get-started/guides/ will not be auto-included; also update the two guide files byo-code.mdx and set-up-tasks.mdx to remove or revise the stale frontmatter key sidebar.order (either delete it or assign distinct, meaningful values) so future maintainers aren’t misled.
🤖 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/get-started/guides/byo-code.mdx`:
- Around line 64-67: The "What you need" heading is currently an H3 and appears
before any H2, causing an orphaned ToC entry; update the heading "### What you
need" to an H2 ("## What you need") or alternatively move that section under a
new or existing H2 like "## Before you begin" so it follows the document's H2
hierarchy (update the heading text in
src/content/docs/get-started/guides/byo-code.mdx wherever "What you need"
appears).
In `@src/content/docs/get-started/guides/set-up-tasks.mdx`:
- Around line 72-75: The "### What you need" heading is an H3 orphan and should
be promoted or nested; update the document so that the heading level is
consistent by either changing "### What you need" to an H2 ("## What you need")
or place its content under an introductory H2 such as "## Before you begin"
(create that H2 if missing) so it follows the H2 → H3 hierarchy expected by
tableOfContents.maxHeadingLevel: 3 and avoids orphaned H3 entries in the ToC.
---
Nitpick comments:
In `@src/content/docs/get-started/guides/byo-code.mdx`:
- Line 80: The sentence contains an accidental double space in the markdown link
text ("head over to our [SDK page]"); locate that exact string in
src/content/docs/get-started/guides/byo-code.mdx and remove the extra space so
it reads "head over to our [SDK page]" (ensure only a single space before the
link and preserve surrounding punctuation and capitalization).
In `@src/content/docs/get-started/guides/first-things-first.mdx`:
- Line 154: Replace the pricing URL in the sentence currently using
"https://www.kinde.com/pricing/" with the canonical "https://kinde.com/pricing/"
so it matches the links used in set-up-tasks.mdx and byo-code.mdx; search for
occurrences of both "https://www.kinde.com/pricing/" and
"https://kinde.com/pricing/" across the get-started guides and normalize them to
"https://kinde.com/pricing/" (update the text in first-things-first.mdx where
that URL appears).
In `@src/data/sidebarData.ts`:
- Around line 12-21: Summary: The "Guides" sidebar entry was converted from
autogenerate to a hardcoded items array so new guide files won't appear
automatically. Edit the sidebar object with label "Guides" (the object that
currently contains an items array) and add a short inline comment above or
beside it noting that this is a curated list and new files under
src/content/docs/get-started/guides/ will not be auto-included; also update the
two guide files byo-code.mdx and set-up-tasks.mdx to remove or revise the stale
frontmatter key sidebar.order (either delete it or assign distinct, meaningful
values) so future maintainers aren’t misled.
🪄 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: Repository UI
Review profile: CHILL
Plan: Pro
Run ID: 73aec7bf-27fa-4d00-b2a9-11fd6c031db1
⛔ Files ignored due to path filters (1)
package-lock.jsonis excluded by!**/package-lock.json
📒 Files selected for processing (4)
src/content/docs/get-started/guides/byo-code.mdxsrc/content/docs/get-started/guides/first-things-first.mdxsrc/content/docs/get-started/guides/set-up-tasks.mdxsrc/data/sidebarData.ts
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (1)
src/content/docs/get-started/guides/set-up-tasks.mdx (1)
5-6: Align frontmatter order with the actual guides sequenceLine 5 sets
order: 2, but this page is the third guide insrc/data/sidebarData.ts(/get-started/guides/set-up-tasks/comes after/get-started/guides/byo-code/). Aligning this toorder: 3avoids metadata drift if ordering logic changes later.Proposed edit
sidebar: - order: 2 + order: 3 label: Common setup tasks🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/content/docs/get-started/guides/set-up-tasks.mdx` around lines 5 - 6, Update the frontmatter "order" value for the page with slug "/get-started/guides/set-up-tasks/" from 2 to 3 so it matches its position in the guides sequence; locate the frontmatter block at the top of the set-up-tasks page and change the order key to 3 to prevent metadata drift with the sidebar ordering.
🤖 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/get-started/guides/byo-code.mdx`:
- Line 154: Replace the unhyphenated phrase "sign up process" in the sentence
"Complete the sign up process and you'll be redirected back to your app's
dashboard page." with the compound modifier "sign-up process"; search for and
update any other occurrences of "sign up" used as a compound modifier in the
same document to "sign-up" to keep style consistent.
- Around line 215-217: Update the wording in the "Quick start" steps that
mention using the dashboard "Get token" (the bullet lines referencing "Quick
start" and "Get token") to explicitly state these dashboard-generated tokens are
for testing/dev only and must not be used in production; replace or augment step
6–7 with a clear recommendation to implement a server-side client-credentials
token exchange (or equivalent server-side auth flow) with secrets stored
securely (e.g., environment variables or a secrets manager) and indicate
dashboard tokens are only for manual testing or troubleshooting.
In `@src/content/docs/get-started/guides/set-up-tasks.mdx`:
- Line 117: Update the link label "[Add social sign in with
Kinde](/authenticate/social-sign-in/add-social-sign-in/)" to use the hyphenated
compound "sign-in" so the label reads "[Add social sign-in with
Kinde](/authenticate/social-sign-in/add-social-sign-in/)"; locate the markdown
link in the document (the link text beginning "Add social sign in with Kinde")
and replace the label only, leaving the URL unchanged.
---
Nitpick comments:
In `@src/content/docs/get-started/guides/set-up-tasks.mdx`:
- Around line 5-6: Update the frontmatter "order" value for the page with slug
"/get-started/guides/set-up-tasks/" from 2 to 3 so it matches its position in
the guides sequence; locate the frontmatter block at the top of the set-up-tasks
page and change the order key to 3 to prevent metadata drift with the sidebar
ordering.
🪄 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: Repository UI
Review profile: CHILL
Plan: Pro
Run ID: 373f15a9-9476-4111-8339-209ef580a817
📒 Files selected for processing (2)
src/content/docs/get-started/guides/byo-code.mdxsrc/content/docs/get-started/guides/set-up-tasks.mdx
1 participant
Rewrites and restructures three core "Get Started" guide pages — First things first, Add Kinde to your codebase, and Common setup tasks — with expanded content, improved frontmatter/metadata, AI summaries, screenshots, and new sections (e.g., roles & permissions, test environments, advanced setup). Also updates the sidebar to use a manually ordered guide list, removing the starter kit entry and pinning the four main guide pages in the correct reading order.
Summary by CodeRabbit