Skip to content

Update: Getting Started guide pages overhaul#725

Open
tamalchowdhury wants to merge 18 commits into
mainfrom
tamal/update/onboarding-for-non-technical-users
Open

Update: Getting Started guide pages overhaul#725
tamalchowdhury wants to merge 18 commits into
mainfrom
tamal/update/onboarding-for-non-technical-users

Conversation

@tamalchowdhury

@tamalchowdhury tamalchowdhury commented Apr 21, 2026

Copy link
Copy Markdown
Collaborator

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

  • Documentation
    • Added a new “First things first” onboarding walkthrough (registration + email verification, business/domain setup, project creation, sign-in methods, and team onboarding), replacing the prior entry point.
    • Retitled and restructured the “Byo code” guide into an auth-focused Quickstart, including app setup, callback/redirect configuration, environment variables, registration testing, and updated build/deploy guidance (with updated links and cautions).
    • Reworked the set-up tasks guide into an ordered reference covering auth strategies, branding, RBAC user management, and growth/analytics setup.
  • Navigation
    • Updated the “Get started” sidebar to a curated set of guide links.

@coderabbitai

coderabbitai Bot commented Apr 21, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: fa123549-b5f3-451b-be5b-b51f8c8662e1

📥 Commits

Reviewing files that changed from the base of the PR and between c7c7d7b and 339a06f.

📒 Files selected for processing (3)
  • src/content/docs/get-started/guides/byo-code.mdx
  • src/content/docs/get-started/guides/first-things-first.mdx
  • src/content/docs/get-started/guides/set-up-tasks.mdx
✅ Files skipped from review due to trivial changes (1)
  • src/content/docs/get-started/guides/set-up-tasks.mdx
🚧 Files skipped from review as they are similar to previous changes (1)
  • src/content/docs/get-started/guides/first-things-first.mdx

Walkthrough

Three "Get started" guides were restructured with expanded onboarding flows and clearer instructional pathways. Sidebar navigation was switched from autogenerated guides directory to an explicit list of guide entries.

Changes

Get Started Guides and Navigation Restructure

Layer / File(s) Summary
First things first: Account setup
src/content/docs/get-started/guides/first-things-first.mdx
Replaced "Where to start with Kinde" with a step-by-step onboarding walkthrough covering registration, email verification, business details, first project creation, sign-in method selection, dashboard completion, team member invitation with role/plan constraints, and updated next-step links.
byo-code: Code integration quickstart
src/content/docs/get-started/guides/byo-code.mdx
Restructured guide to present "Add Kinde auth to your codebase" with numbered quickstart steps: application creation, SDK selection, callback/redirect URLs, credential copying, .env configuration example, and signup testing via the Kinde Users dashboard.
Build and deploy with environments and Management API
src/content/docs/get-started/guides/byo-code.mdx
Added comprehensive "Build and deploy" section covering non-production test environments, back-end API registration for access token aud claims, Kinde Management API setup via machine-to-machine application, production deployment checklist for Vercel/Netlify/Cloudflare Workers, and updated next-step navigation.
Set-up tasks: Configuration reference
src/content/docs/get-started/guides/set-up-tasks.mdx
Rewrote from checklist-style layout into four instructional areas: authentication strategy and social/enterprise connections, branding customization (hosted auth page, custom domain, email sender), user management with imports and RBAC, and growth setup with request access, subscription forms, analytics, and UTM tags; updated next steps to multi-tenancy and billing.
Navigation sidebar configuration
src/data/sidebarData.ts
Replaced directory-based autogenerate for "Get started" guides with a hard-coded list of four explicit guide entries; retained expanded (uncollapsed) state.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Poem

🐰 I hopped through docs by moonlight glow,
Reworded guides so new devs know,
Quickstarts, deploys, and signup flows,
Sidebars tidy where the pathway goes,
A joyful twitch — the onboarding grows! 🥕✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately reflects the main change: a comprehensive overhaul/restructuring of the Getting Started guide pages, which aligns with the significant rewrites of three core guides and sidebar updates.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch tamal/update/onboarding-for-non-technical-users

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Apr 21, 2026

Copy link
Copy Markdown

Deploying kinde-docs-preview with  Cloudflare Pages  Cloudflare Pages

Latest commit: 339a06f
Status: ✅  Deploy successful!
Preview URL: https://a867fc79.kinde-docs-preview.pages.dev
Branch Preview URL: https://tamal-update-onboarding-for.kinde-docs-preview.pages.dev

View logs

@tamalchowdhury tamalchowdhury marked this pull request as ready for review April 27, 2026 15:13
@tamalchowdhury tamalchowdhury requested review from a team as code owners April 27, 2026 15:13
@tamalchowdhury tamalchowdhury changed the title 🚧 Work in Progress: fix: onboarding steps for non technical users fix: Overhaul of Get Started guide pages Apr 27, 2026

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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/, while set-up-tasks.mdx (line 145) and byo-code.mdx use https://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 Guides from autogenerate to a hardcoded items list is fine for the curated set, but any new file added under src/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.mdx and set-up-tasks.mdx both still declare sidebar.order: 2 in frontmatter; with the hardcoded list, those values are now decorative/stale. You may want to drop the order key (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

📥 Commits

Reviewing files that changed from the base of the PR and between dbad554 and c78b303.

⛔ Files ignored due to path filters (1)
  • package-lock.json is excluded by !**/package-lock.json
📒 Files selected for processing (4)
  • src/content/docs/get-started/guides/byo-code.mdx
  • src/content/docs/get-started/guides/first-things-first.mdx
  • src/content/docs/get-started/guides/set-up-tasks.mdx
  • src/data/sidebarData.ts

Comment thread src/content/docs/get-started/guides/byo-code.mdx Outdated
Comment thread src/content/docs/get-started/guides/set-up-tasks.mdx Outdated

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 sequence

Line 5 sets order: 2, but this page is the third guide in src/data/sidebarData.ts (/get-started/guides/set-up-tasks/ comes after /get-started/guides/byo-code/). Aligning this to order: 3 avoids 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

📥 Commits

Reviewing files that changed from the base of the PR and between c78b303 and 19f4ef2.

📒 Files selected for processing (2)
  • src/content/docs/get-started/guides/byo-code.mdx
  • src/content/docs/get-started/guides/set-up-tasks.mdx

Comment thread src/content/docs/get-started/guides/byo-code.mdx Outdated
Comment thread src/content/docs/get-started/guides/byo-code.mdx
Comment thread src/content/docs/get-started/guides/set-up-tasks.mdx Outdated
@tamalchowdhury tamalchowdhury changed the title fix: Overhaul of Get Started guide pages fix: Getting Started guide pages overhaul May 15, 2026
@dtoxvanilla1991

Copy link
Copy Markdown
Contributor

@tamalchowdhury is this review for a review? If not, could you make it a draft then for now.

@tamalchowdhury tamalchowdhury changed the title fix: Getting Started guide pages overhaul Update: Getting Started guide pages overhaul Jun 17, 2026
2. Choose a **Kinde domain name** (e.g., `yourbrand.kinde.com`)

<Aside type="warning">
Once you set the **Kinde domain name**, you cannot change it later. If you need the same domain for a different business, see [Start a new business but keep your domain](/manage-your-account/your-data/kinde-domains/#to-start-a-new-business-but-keep-your-domain). You can also [add a custom domain](/build/domains/pointing-your-domain/) to compleley remove the need for a Kinde domain.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Spelling mistake compleley -> completely

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed it, thanks for the catch.

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants