Skip to content

docs(auth): regroup the SSR client guide and cut repetition - #50287

Draft
czenko wants to merge 1 commit into
docs/ssr-client-stylefrom
docs/ssr-client-structure
Draft

docs(auth): regroup the SSR client guide and cut repetition#50287
czenko wants to merge 1 commit into
docs/ssr-client-stylefrom
docs/ssr-client-structure

Conversation

@czenko

@czenko czenko commented Sep 11, 2026

Copy link
Copy Markdown
Contributor

Problem

_partials/auth_methods.mdx was included six times in this one page. Radix unmounts inactive tab panels, so a browser reader sees it three times on the default Next.js view, and the generated markdown that agents read contained all six. That was about 25% of the 33.5 KB export, and it put the same Summary of the methods heading in the table of contents three times over.

The page is also 900+ lines with no intro outline, the per-framework recaps were h2 inside an h2 section, and six of the nine panels had no step headings at all.

Solution

  • Include the auth methods partial once, under a new Choosing an auth method section grouped with Caching considerations, and point to it from the procedure. This follows the mixed information types rule in apps/docs/CONTRIBUTING.md.
  • Add an intro outline linking the section groups and saying when to read the two reference sections.
  • Demote the eight in-tab Congratulations headings to h3 so they nest under Create a client.
  • Add a Create the Supabase clients heading to Astro, Remix, Nuxt, React Router, Express, and Hono, and the recap Hono was missing.

No claims changed here, only placement.

Manual testing

  1. Open the SSR client guide on the deploy preview. The table of contents lists Summary of the methods once.
  2. Select each of the five links in the intro paragraph. Each one scrolls to its section.
  3. Select each framework tab. Every panel has a step heading and a recap.

Part of DOCS-1313.

Summary by CodeRabbit

  • Documentation
    • Added an introductory setup overview covering installation, environment variables, client creation, authentication methods, and caching.
    • Added dedicated guidance for choosing an authentication method.
    • Added Astro SSR and client sections, along with a complete Hono recap.
    • Reorganized framework headings for clearer navigation.
    • Removed duplicated authentication guidance from individual framework sections.

@vercel

vercel Bot commented Sep 11, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
docs Ready Ready Preview, v0 Sep 12, 2026 3:46am UTC
7 Skipped Deployments
Project Deployment Actions Updated
studio Ignored Ignored Sep 12, 2026 3:46am UTC
design-system Skipped Skipped Sep 12, 2026 3:46am UTC
kb Skipped Skipped Sep 12, 2026 3:46am UTC
studio-self-hosted Skipped Skipped Sep 12, 2026 3:46am UTC
studio-staging Skipped Skipped Sep 12, 2026 3:46am UTC
ui-library Skipped Skipped Sep 12, 2026 3:46am UTC
zone-www-dot-com Skipped Skipped Sep 12, 2026 3:46am UTC

Request Review

@vercel
vercel Bot temporarily deployed to Preview – kb September 11, 2026 22:49 Inactive
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Sep 11, 2026
@coderabbitai

coderabbitai Bot commented Sep 11, 2026

Copy link
Copy Markdown
Contributor

Review Change StackReview Change Stack

Important

Draft PR not reviewed

Draft PRs are not automatically reviewed by default.

  • Trigger a manual review

To automatically review draft PRs, update your CodeRabbit configuration:

reviews:
  auto_review:
    drafts: true

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Advanced

Run ID: 968b17ea-5740-4b0f-a699-689d7bbf09cf

📥 Commits

Reviewing files that changed from the base of the PR and between cf1e1cd and 8ca3086.

📒 Files selected for processing (1)
  • apps/docs/content/guides/auth/server-side/creating-a-client.mdx
🚧 Files skipped from review as they are similar to previous changes (1)
  • apps/docs/content/guides/auth/server-side/creating-a-client.mdx

Included review availability: Your plan provides up to 10 included reviews per hour; 3 remain after this review.


📝 Walkthrough

Walkthrough

The server-side client guide now includes setup and caching links, consolidated auth-method guidance, structured framework subsections, Astro client sections, and a Hono recap.

Changes

Auth client guide

Layer / File(s) Summary
Guide overview and auth method guidance
apps/docs/content/guides/auth/server-side/creating-a-client.mdx
The guide adds setup and caching links, removes repeated auth-method inclusions, and adds a dedicated auth-method section.
Framework subsection organization
apps/docs/content/guides/auth/server-side/creating-a-client.mdx
Framework client-creation sections receive subsection headings and consistent completion heading levels.
Hono client setup recap
apps/docs/content/guides/auth/server-side/creating-a-client.mdx
The Hono section adds a client-creation heading and a recap of middleware clients and authenticated route usage.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

Suggested reviewers: mandarini

Merge Risk: ⚪ Minimal · up to 8ca30

The documentation reorganization has no identified merge-blocking risk.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the main documentation changes: restructuring the SSR client guide and removing repeated content.
Description check ✅ Passed The description provides detailed problem, solution, testing, and issue context. It does not include the template’s explicit CONTRIBUTING.md confirmation or its required section headings, but the rele…
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
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.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/ssr-client-structure

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.

@czenko
czenko added this pull request to stack #50290 September 11, 2026 22:49
@supabase

supabase Bot commented Sep 11, 2026

Copy link
Copy Markdown

This pull request has been ignored for the connected project xguihxuzqibwxjnimxev because there are no changes detected in supabase directory. You can change this behaviour in Project Integrations Settings ↗︎.


Preview Branches by Supabase.
Learn more about Supabase Branching ↗︎.

@czenko
czenko force-pushed the docs/ssr-client-structure branch from df587eb to cf1e1cd Compare September 11, 2026 23:06
@vercel
vercel Bot temporarily deployed to Preview – kb September 11, 2026 23:06 Inactive
@czenko

czenko commented Sep 11, 2026

Copy link
Copy Markdown
Contributor Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Sep 11, 2026

Copy link
Copy Markdown
Contributor
✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@czenko
czenko force-pushed the docs/ssr-client-structure branch from cf1e1cd to f486b7c Compare September 11, 2026 23:10
@vercel
vercel Bot temporarily deployed to Preview – kb September 11, 2026 23:10 Inactive
@czenko
czenko force-pushed the docs/ssr-client-structure branch from f486b7c to d902892 Compare September 11, 2026 23:14
@vercel
vercel Bot temporarily deployed to Preview – kb September 11, 2026 23:14 Inactive
@czenko
czenko force-pushed the docs/ssr-client-structure branch from d902892 to 8ca3086 Compare September 11, 2026 23:17
@vercel
vercel Bot temporarily deployed to Preview – kb September 11, 2026 23:17 Inactive
@czenko

czenko commented Sep 11, 2026

Copy link
Copy Markdown
Contributor Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Sep 11, 2026

Copy link
Copy Markdown
Contributor
✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

The auth methods partial was included six times in this one page, which
is about 25% of the generated markdown export. Include it once, under a
new "Choosing an auth method" section grouped with the other reference
section, and point to it from the procedure.

Add an intro outline, since the page is long enough to need one. Demote
the per-framework recaps to h3 so they nest under "Create a client",
give the six panels that had no step headings the same shape as the
other three, and add the recap Hono was missing.

Those repeated per-framework headings would have collided on one anchor
each, so override the id on all 17 of them. Every heading on the page now
has a unique id.
@czenko
czenko force-pushed the docs/ssr-client-structure branch from 8ca3086 to 06126f4 Compare September 12, 2026 03:39
@vercel
vercel Bot temporarily deployed to Preview – kb September 12, 2026 03:39 Inactive
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant