docs(auth): regroup the SSR client guide and cut repetition - #50287
docs(auth): regroup the SSR client guide and cut repetition#50287czenko wants to merge 1 commit into
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
7 Skipped Deployments
|
|
Important Draft PR not reviewedDraft PRs are not automatically reviewed by default.
To automatically review draft PRs, update your CodeRabbit configuration: reviews:
auto_review:
drafts: trueNo actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Advanced Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
Included review availability: Your plan provides up to 10 included reviews per hour; 3 remain after this review. 📝 WalkthroughWalkthroughThe server-side client guide now includes setup and caching links, consolidated auth-method guidance, structured framework subsections, Astro client sections, and a Hono recap. ChangesAuth client guide
Priority: ⬇️ Low Estimated code review effort: 1 (Trivial) | ~5 minutes Change: Other Suggested reviewers: Merge Risk: ⚪ Minimal · up to The documentation reorganization has no identified merge-blocking risk. 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ 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 |
|
This pull request has been ignored for the connected project Preview Branches by Supabase. |
df587eb to
cf1e1cd
Compare
|
@coderabbitai review |
✅ Action performedReview finished.
|
cf1e1cd to
f486b7c
Compare
f486b7c to
d902892
Compare
d902892 to
8ca3086
Compare
|
@coderabbitai review |
✅ Action performedReview finished.
|
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.
8ca3086 to
06126f4
Compare
Problem
_partials/auth_methods.mdxwas 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 sameSummary of the methodsheading in the table of contents three times over.The page is also 900+ lines with no intro outline, the per-framework recaps were
h2inside anh2section, and six of the nine panels had no step headings at all.Solution
Choosing an auth methodsection grouped withCaching considerations, and point to it from the procedure. This follows the mixed information types rule inapps/docs/CONTRIBUTING.md.Congratulationsheadings toh3so they nest underCreate a client.Create the Supabase clientsheading to Astro, Remix, Nuxt, React Router, Express, and Hono, and the recap Hono was missing.No claims changed here, only placement.
Manual testing
Summary of the methodsonce.Part of DOCS-1313.
Summary by CodeRabbit