Skip to content

docs: improve documentation structure and section organization#168

Merged
halvaradop merged 4 commits into
masterfrom
docs/refine-docs-app
May 24, 2026
Merged

docs: improve documentation structure and section organization#168
halvaradop merged 4 commits into
masterfrom
docs/refine-docs-app

Conversation

@halvaradop
Copy link
Copy Markdown
Member

@halvaradop halvaradop commented May 24, 2026

It's bed time.

Gooooooo

Summary by CodeRabbit

  • Documentation
    • Added comprehensive "Getting Started" section with installation, introduction, and quick-start guides.
    • Added "Examples" section showcasing framework implementations (Next.js, Astro, React Router, Nuxt, Bun, Deno, Express, and more).
    • Reorganized and expanded integration guides with updated setup patterns and examples.
    • Added new Core Concepts documentation covering TypeScript, environment variables, OAuth, and architecture.
    • Added FAQ page addressing common questions.
    • Streamlined OAuth provider documentation pages.

Review Change Stack

- add examples section
- add security section
- add installation guide
@vercel
Copy link
Copy Markdown
Contributor

vercel Bot commented May 24, 2026

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

Project Deployment Actions Updated (UTC)
auth Ready Ready Preview, Comment May 24, 2026 7:45pm

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 24, 2026

Warning

Review limit reached

@halvaradop, we couldn't start this review because you've used your available PR reviews for now.

Your plan includes 1 review of capacity. Refill in 10 minutes and 28 seconds.

Your organization has run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After more review capacity refills, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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 trial, open-source, and free plans. In all cases, review capacity refills continuously over time.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: a111fc09-e6ae-49b6-85c1-4bad25a855c8

📥 Commits

Reviewing files that changed from the base of the PR and between dbdf58f and 3e1c184.

📒 Files selected for processing (10)
  • docs/src/content/docs/(core)/integrations/astro.mdx
  • docs/src/content/docs/(core)/integrations/bun.mdx
  • docs/src/content/docs/(core)/integrations/cloudflare-workers.mdx
  • docs/src/content/docs/(core)/integrations/deno.mdx
  • docs/src/content/docs/(core)/integrations/express.mdx
  • docs/src/content/docs/(core)/integrations/next-app-router.mdx
  • docs/src/content/docs/(core)/integrations/next-pages-router.mdx
  • docs/src/content/docs/(core)/integrations/nuxt.mdx
  • docs/src/content/docs/(core)/integrations/react-router.mdx
  • docs/src/content/docs/(core)/integrations/supabase-edge-functions.mdx
📝 Walkthrough

Walkthrough

This PR comprehensively restructures the Aura Auth documentation site from a flat hierarchy to a nested structure with "(core)" and "examples" top-level sections. Navigation is updated to reflect the new routing, the docs page header layout is refactored, and the Getting Started section is introduced with onboarding content. Core concepts, guides, and 16 framework integration pages are reorganized with cleaner structures and updated cross-references. A new Examples catalog with 14 framework implementations is added alongside 16 standardized OAuth provider pages. Supporting utilities and TypeScript configuration changes complete the restructure.

Changes

Documentation Site Restructure

Layer / File(s) Summary
Navigation and Layout Refactoring
docs/src/components/home/header.tsx, docs/src/app/docs/[[...slug]]/page.tsx, docs/src/app/layout.tsx, docs/src/lib/layout.shared.tsx
Home header Docs link routes to /docs/introduction. Docs page header layout split into flex row for title/controls and separate description block with border styling. Next.js metadata export added with title default and template. Custom GitHub link removed from layout configuration.
Documentation Hierarchy and Root Metadata
docs/src/content/docs/meta.json, docs/src/content/docs/index.mdx, docs/src/content/docs/(core)/meta.json
Root docs metadata narrowed to "(core)" and "examples" sections. Root index page emptied. New Core section metadata added with description, page ordering (Getting Started, Core Concepts, Guides, API Reference, Integrations, OAuth, Security, FAQ, Contributing), and root flag.
Getting Started Onboarding Section
docs/src/content/docs/(core)/(getting-started)/*, docs/src/content/docs/(core)/(getting-started)/meta.json
New Getting Started section with introduction describing features and philosophy via feature cards and OAuth provider highlights, installation guide with step-based setup (package install, framework-specific project structures, environment variables, TypeScript config), and quick-start guide with auth instance creation, HTTP handler mounting across multiple frameworks, and client initialization.
Core Concepts Section
docs/src/content/docs/(core)/concepts/*, docs/src/content/docs/(core)/concepts/meta.json
New Core Concepts section metadata. TypeScript page simplified to remove Overview header and Type Extension section. Environment variables heading removed. OAuth title updated to "OAuth 2.0 Authorization Framework" with new "Why Aura Auth Simplifies OAuth 2.0" callout added. Architecture page resources updated to remove environment and cookie config links.
Guides Section with Schema Validation
docs/src/content/docs/(core)/guides/*, docs/src/content/docs/(core)/guides/meta.json
Guides section metadata established. New schema-validation guide added explaining identity.schema configuration and type derivation via Zod with two TypeScript examples. Cookie-management guide reorganized with clearer "Cookie Configuration," "Cookie Overrides," and "Strategy Attribute" sections. Jose-utilities introduction shortened and "What you'll learn" sections removed from custom-providers and integration guides.
FAQ Page and Documentation Cleanup
docs/src/content/docs/(core)/faq.mdx, docs/src/content/docs/(core)/api-reference/*
New FAQ page added with accordion-based answers about Aura Auth's origin and secure-by-default philosophy. "What you'll learn" sections removed from API reference core, jose, security-model, and contributing pages. API reference metadata updated to include options page.
OAuth Provider Pages Standardization
docs/src/content/docs/(core)/oauth/*.mdx, docs/src/content/docs/(core)/oauth/index.mdx, docs/src/content/docs/(core)/integrations/meta.json
16 OAuth provider pages (Atlassian, Bitbucket, ClickUp, Discord, Dribbble, Dropbox, Figma, GitHub, GitLab, Mailchimp, Notion, Pinterest, Spotify, Strava, Twitch, X) standardized with shortened titles and consistent descriptions. OAuth index page overview and "What you'll learn" sections removed. Integrations meta.json section label changed from "Frontend" to "Fullstack.".

Framework Integration Guides

Layer / File(s) Summary
Fullstack Framework Integrations
docs/src/content/docs/(core)/integrations/next-app-router.mdx, docs/src/content/docs/(core)/integrations/next-pages-router.mdx, docs/src/content/docs/(core)/integrations/astro.mdx, docs/src/content/docs/(core)/integrations/nuxt.mdx, docs/src/content/docs/(core)/integrations/react-router.mdx
Comprehensive guides for Next.js App Router and Pages Router, Astro, Nuxt, and React Router covering auth instance setup, HTTP handler mounting, SSR/CSR patterns, session retrieval, sign-in/out flows, and updated documentation resource links.
Backend Server Integrations
docs/src/content/docs/(core)/integrations/express.mdx, docs/src/content/docs/(core)/integrations/hono.mdx, docs/src/content/docs/(core)/integrations/bun.mdx, docs/src/content/docs/(core)/integrations/oak.mdx, docs/src/content/docs/(core)/integrations/elysia.mdx
Integration guides for Express (with new withAuth middleware replacing verifySession), Hono, Bun, Oak, and Elysia with native server setup, middleware patterns for session management, route handler configuration, and basePath/baseURL alignment callouts.
Edge Functions and Deno Integrations
docs/src/content/docs/(core)/integrations/cloudflare-workers.mdx, docs/src/content/docs/(core)/integrations/vercel-edge-functions.mdx, docs/src/content/docs/(core)/integrations/supabase-edge-functions.mdx, docs/src/content/docs/(core)/integrations/deno.mdx
Guides for Cloudflare Workers, Vercel Edge Functions, Supabase Edge Functions, and Deno covering edge runtime patterns, auth handler routing, and deployment-specific configurations with updated documentation references.

Examples Catalog

Layer / File(s) Summary
Examples Section Metadata
docs/src/content/docs/examples/meta.json
New Examples section metadata with root flag, section title/description, and categorized page list for Fullstack (Next.js variants, Astro, Nuxt, React Router), Backend (Express, Hono, Bun, Oak), and Edge (Cloudflare Workers, Vercel Edge, Supabase Edge, Deno, Elysia, TanStack Start).
Fullstack Runtime Examples
docs/src/content/docs/examples/next-app-router.mdx, docs/src/content/docs/examples/next-pages-router.mdx, docs/src/content/docs/examples/astro.mdx, docs/src/content/docs/examples/nuxt.mdx, docs/src/content/docs/examples/react-router.mdx
Example documentation pages for Next.js App Router, Next.js Pages Router, Astro, Nuxt, and React Router with descriptive text and StackBlitz embeds for interactive framework-specific authentication examples.
Backend Runtime Examples
docs/src/content/docs/examples/express.mdx, docs/src/content/docs/examples/hono.mdx, docs/src/content/docs/examples/bun.mdx, docs/src/content/docs/examples/oak.mdx
Example pages for Express, Hono, Bun, and Oak with StackBlitz embeds demonstrating backend server authentication patterns using Aura Auth.
Edge Runtime Examples
docs/src/content/docs/examples/cloudflare-workers.mdx, docs/src/content/docs/examples/vercel-edge-functions.mdx, docs/src/content/docs/examples/supabase-edge-functions.mdx, docs/src/content/docs/examples/deno.mdx, docs/src/content/docs/examples/elysia.mdx, docs/src/content/docs/examples/tanstack-start.mdx
Example pages for Cloudflare Workers, Vercel Edge Functions, Supabase Edge Functions, Deno, Elysia, and TanStack Start with StackBlitz embeds for edge runtime implementations.

Supporting Utilities and Configuration

Layer / File(s) Summary
Utility Exports and TypeScript Configuration
docs/src/lib/cn.ts, docs/src/lib/merge-refs.ts, docs/src/mdx-components.tsx, docs/tsconfig.json
New cn utility re-exporting twMerge. New mergeRefs helper combining multiple React refs into a single callback. MDX components extended with accordion support from fumadocs-ui. TypeScript config updated to ignore deprecation warnings for version 6.0.

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~45 minutes

Possibly related PRs

  • aura-stack-ts/auth#133: Updates and restructures the same framework integration documentation pages (Astro, Bun, Express, etc.), building directly on the integration guides added in this PR.
  • aura-stack-ts/auth#87: Updates home header navigation in docs/src/components/home/header.tsx—this PR changes the Docs link route to /docs/introduction, aligning with home page UI work from PR #87.
  • aura-stack-ts/auth#132: Modifies MDX rendering setup in docs/src/mdx-components.tsx by extending component maps; this PR adds accordion support via the same mechanism.

Suggested labels

documentation

Poem

📚✨ A thousand docs rewoven bright,
From scattered guides to nested light!
New examples bloom across the land,
While frameworks gather, side by side they stand.
Clean paths for seekers, OAuth in line—
The rabbit hops through this restructured design! 🐰

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/refine-docs-app

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 15

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/src/content/docs/`(core)/(getting-started)/introduction.mdx:
- Around line 13-17: The two Card components with titles "Framework-agnostic"
and "Runtime-agnostic" use broken hrefs ('/docs/concepts/frameworks' and
'/docs/concepts/runtimes'); update those href values in the Card elements to the
actual, existing concept routes introduced in this PR cohort (verify the correct
route names in the docs index) so the Card components
(title="Framework-agnostic" and title="Runtime-agnostic") point to valid pages;
after updating, run the local docs build or link check to confirm the routes no
longer 404.

In `@docs/src/content/docs/`(core)/(getting-started)/quick-start.mdx:
- Line 90: The Tabs component's items prop is missing the "elysia" entry, making
the nested elysia panel unreachable; update the Tabs usage (the items prop on
the Tabs component) to include "elysia" in the array or remove the elysia tab
panel block so every defined panel has a corresponding item in the items array.
- Around line 131-135: The docs use res.setHeaders(response.headers) which
NextApiResponse (Pages Router) doesn't support; replace those calls by iterating
over response.headers and calling res.setHeader(name, value) for each header
before invoking res.redirect(response.status, location) (and in the other branch
where res.setHeaders(response.headers) appears), ensuring you set headers from
the response.headers object using res.setHeader rather than res.setHeaders;
refer to the occurrences of res.setHeaders, res.setHeader, response.headers, and
res.redirect to locate and update the snippet.

In `@docs/src/content/docs/`(core)/fqa.mdx:
- Around line 1-4: Rename the file from fqa.mdx to faq.mdx and update the
frontmatter title value from "FQA" to "FAQ" (the file's frontmatter block that
contains title/description), and search for any references to "fqa.mdx" or "FQA"
in navigation or links and replace them with "faq.mdx" / "FAQ" so routing and
page titles reflect the correct abbreviation.
- Around line 10-12: Update the sentence that currently reads "However, on
September 26, 2025, it was announced that the core maintainer team would be
stepping away from Auth.js, which has now become a side project of Better
Auth..." in docs/src/content/docs/(core)/fqa.mdx: change the date to "September
22, 2025" (or "Sep 22, 2025") and adjust the wording to match the Better Auth
announcement (e.g., "is now part of Better Auth" or "transitioned to Better
Auth") so the sentence reflects the correct date and phrasing used in the Better
Auth blog post.

In `@docs/src/content/docs/`(core)/guides/schema-validation.mdx:
- Line 6: The intro paragraph is a run-on with unclear phrasing—revise to clear,
grammatical sentences: replace "For the type extension" with a clearer opener,
state that Aura Auth exposes the identity.schema configuration option, explain
that it defines a custom validation schema for user identity data, and change
"is used as `User` and `Session` types" to "is used to derive the `User` and
`Session` types"; split into two short sentences and keep references to
`identity.schema`, `User`, `Session`, and Aura Auth so readers can find the
option and its purpose.

In `@docs/src/content/docs/`(core)/oauth/atlassian.mdx:
- Around line 2-3: Update the frontmatter description value: replace the current
description text that reads "Add Atlassian authorization provider to Aura Auth
to authentication and authorize" with the corrected phrase "Add Atlassian
authorization provider to Aura Auth for authentication and authorization" by
editing the description field in the document frontmatter.

In `@docs/src/content/docs/`(core)/oauth/github.mdx:
- Around line 2-3: Update the front-matter fields: change the title value from
"Github" to "GitHub", and fix the description value to read "Add GitHub
authorization provider to Aura Auth to authenticate and authorize" (replacing
"to authentication and authorize"); modify the `title` and `description` entries
shown in the diff accordingly.

In `@docs/src/content/docs/`(core)/oauth/gitlab.mdx:
- Line 3: Fix the grammar in the GitLab provider description by replacing the
phrase "to authentication and authorize" with "to authenticate and authorize" in
the docs sentence that starts with "Add GitLab authorization provider to Aura
Auth to authentication and authorize"; update that exact string in the
gitlab.mdx content so it reads "...to authenticate and authorize".

In `@docs/src/content/docs/`(core)/oauth/mailchimp.mdx:
- Line 3: Update the description frontmatter string that currently reads "Add
Mailchimp authorization provider to Aura Auth to authentication and authorize"
by replacing "to authentication and authorize" with "to authenticate and
authorize" so the description reads "Add Mailchimp authorization provider to
Aura Auth to authenticate and authorize"; locate the line that begins with the
description key and edit the sentence accordingly.

In `@docs/src/content/docs/`(core)/oauth/notion.mdx:
- Line 3: The description sentence currently reads "Add Notion authorization
provider to Aura Auth to authentication and authorize"; update it to correct
grammar by replacing "to authentication and authorize" with "to authenticate and
authorize" so the full line becomes "Add Notion authorization provider to Aura
Auth to authenticate and authorize."

In `@docs/src/content/docs/`(core)/oauth/pinterest.mdx:
- Line 3: Update the front-matter "description" value that currently reads "Add
Pinterest authorization provider to Aura Auth to authentication and authorize"
to correct grammar by changing "to authentication and authorize" to "to
authenticate and authorize" so the full sentence reads "Add Pinterest
authorization provider to Aura Auth to authenticate and authorize".

In `@docs/src/content/docs/`(core)/oauth/strava.mdx:
- Line 3: Update the YAML frontmatter description string: replace the incorrect
phrase "to authentication and authorize" with the correct wording "to
authenticate and authorize" in the description field (the YAML key
"description") so the sentence reads "Add Strava authorization provider to Aura
Auth to authenticate and authorize".

In `@docs/src/content/docs/`(core)/oauth/twitch.mdx:
- Around line 2-3: Update the frontmatter description so the sentence reads
correctly: change the description value from "Add Twitch authorization provider
to Aura Auth to authentication and authorize" to "Add Twitch authorization
provider to Aura Auth to authenticate and authorize" (edit the description field
in the frontmatter block near the "title: Twitch" entry).

In `@docs/tsconfig.json`:
- Line 4: Remove the blanket deprecation suppression by deleting the
"ignoreDeprecations" compiler option and migrate away from the deprecated
"compilerOptions.baseUrl": remove the "baseUrl" entry and replace its behavior
by adding appropriate "compilerOptions.paths" mappings that preserve the same
import prefixes, and update any README/docs comment explaining the change and
why the deprecation suppression was removed.
🪄 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: defaults

Review profile: CHILL

Plan: Pro

Run ID: c5630f39-9e34-4bb5-893e-b5b3115ab113

📥 Commits

Reviewing files that changed from the base of the PR and between f41ea7e and 97762ff.

📒 Files selected for processing (82)
  • docs/src/app/docs/[[...slug]]/page.tsx
  • docs/src/components/home/header.tsx
  • docs/src/content/docs/(core)/(getting-started)/installation.mdx
  • docs/src/content/docs/(core)/(getting-started)/introduction.mdx
  • docs/src/content/docs/(core)/(getting-started)/meta.json
  • docs/src/content/docs/(core)/(getting-started)/quick-start.mdx
  • docs/src/content/docs/(core)/api-reference/core.mdx
  • docs/src/content/docs/(core)/api-reference/jose.mdx
  • docs/src/content/docs/(core)/api-reference/meta.json
  • docs/src/content/docs/(core)/api-reference/options.mdx
  • docs/src/content/docs/(core)/concepts/architecture.mdx
  • docs/src/content/docs/(core)/concepts/env.mdx
  • docs/src/content/docs/(core)/concepts/meta.json
  • docs/src/content/docs/(core)/concepts/oauth.mdx
  • docs/src/content/docs/(core)/concepts/typescript.mdx
  • docs/src/content/docs/(core)/contributing.mdx
  • docs/src/content/docs/(core)/fqa.mdx
  • docs/src/content/docs/(core)/guides/cookie-management.mdx
  • docs/src/content/docs/(core)/guides/custom-providers.mdx
  • docs/src/content/docs/(core)/guides/integration.mdx
  • docs/src/content/docs/(core)/guides/jose-utilities.mdx
  • docs/src/content/docs/(core)/guides/meta.json
  • docs/src/content/docs/(core)/guides/schema-validation.mdx
  • docs/src/content/docs/(core)/integrations/astro.mdx
  • docs/src/content/docs/(core)/integrations/bun.mdx
  • docs/src/content/docs/(core)/integrations/cloudflare-workers.mdx
  • docs/src/content/docs/(core)/integrations/deno.mdx
  • docs/src/content/docs/(core)/integrations/elysia.mdx
  • docs/src/content/docs/(core)/integrations/express.mdx
  • docs/src/content/docs/(core)/integrations/hono.mdx
  • docs/src/content/docs/(core)/integrations/meta.json
  • docs/src/content/docs/(core)/integrations/next-app-router.mdx
  • docs/src/content/docs/(core)/integrations/next-pages-router.mdx
  • docs/src/content/docs/(core)/integrations/nuxt.mdx
  • docs/src/content/docs/(core)/integrations/oak.mdx
  • docs/src/content/docs/(core)/integrations/react-router.mdx
  • docs/src/content/docs/(core)/integrations/supabase-edge-functions.mdx
  • docs/src/content/docs/(core)/integrations/tanstack-start.mdx
  • docs/src/content/docs/(core)/integrations/vercel-edge-functions.mdx
  • docs/src/content/docs/(core)/meta.json
  • docs/src/content/docs/(core)/oauth/atlassian.mdx
  • docs/src/content/docs/(core)/oauth/bitbucket.mdx
  • docs/src/content/docs/(core)/oauth/click-up.mdx
  • docs/src/content/docs/(core)/oauth/discord.mdx
  • docs/src/content/docs/(core)/oauth/dribble.mdx
  • docs/src/content/docs/(core)/oauth/dropbox.mdx
  • docs/src/content/docs/(core)/oauth/figma.mdx
  • docs/src/content/docs/(core)/oauth/github.mdx
  • docs/src/content/docs/(core)/oauth/gitlab.mdx
  • docs/src/content/docs/(core)/oauth/index.mdx
  • docs/src/content/docs/(core)/oauth/mailchimp.mdx
  • docs/src/content/docs/(core)/oauth/meta.json
  • docs/src/content/docs/(core)/oauth/notion.mdx
  • docs/src/content/docs/(core)/oauth/pinterest.mdx
  • docs/src/content/docs/(core)/oauth/spotify.mdx
  • docs/src/content/docs/(core)/oauth/strava.mdx
  • docs/src/content/docs/(core)/oauth/twitch.mdx
  • docs/src/content/docs/(core)/oauth/x.mdx
  • docs/src/content/docs/(core)/security/security-model.mdx
  • docs/src/content/docs/examples/astro.mdx
  • docs/src/content/docs/examples/bun.mdx
  • docs/src/content/docs/examples/cloudflare-workers.mdx
  • docs/src/content/docs/examples/deno.mdx
  • docs/src/content/docs/examples/elysia.mdx
  • docs/src/content/docs/examples/express.mdx
  • docs/src/content/docs/examples/hono.mdx
  • docs/src/content/docs/examples/index.mdx
  • docs/src/content/docs/examples/meta.json
  • docs/src/content/docs/examples/next-app-router.mdx
  • docs/src/content/docs/examples/next-pages-router.mdx
  • docs/src/content/docs/examples/nuxt.mdx
  • docs/src/content/docs/examples/oak.mdx
  • docs/src/content/docs/examples/react-router.mdx
  • docs/src/content/docs/examples/supabase-edge-functions.mdx
  • docs/src/content/docs/examples/tanstack-start.mdx
  • docs/src/content/docs/examples/vercel-edge-functions.mdx
  • docs/src/content/docs/guides/meta.json
  • docs/src/content/docs/index.mdx
  • docs/src/content/docs/meta.json
  • docs/src/content/docs/quick-start.mdx
  • docs/src/lib/layout.shared.tsx
  • docs/tsconfig.json
💤 Files with no reviewable changes (15)
  • docs/src/content/docs/guides/meta.json
  • docs/src/content/docs/(core)/guides/jose-utilities.mdx
  • docs/src/content/docs/index.mdx
  • docs/src/content/docs/(core)/api-reference/core.mdx
  • docs/src/content/docs/quick-start.mdx
  • docs/src/content/docs/(core)/concepts/env.mdx
  • docs/src/content/docs/(core)/guides/integration.mdx
  • docs/src/content/docs/(core)/guides/custom-providers.mdx
  • docs/src/content/docs/(core)/security/security-model.mdx
  • docs/src/content/docs/(core)/oauth/index.mdx
  • docs/src/content/docs/(core)/contributing.mdx
  • docs/src/content/docs/(core)/api-reference/jose.mdx
  • docs/src/content/docs/(core)/concepts/architecture.mdx
  • docs/src/content/docs/(core)/concepts/typescript.mdx
  • docs/src/lib/layout.shared.tsx

Comment thread docs/src/content/docs/(core)/(getting-started)/introduction.mdx Outdated
Comment thread docs/src/content/docs/(core)/(getting-started)/quick-start.mdx
Comment thread docs/src/content/docs/(core)/(getting-started)/quick-start.mdx Outdated
Comment thread docs/src/content/docs/(core)/faq.mdx
Comment thread docs/src/content/docs/(core)/fqa.mdx Outdated
Comment thread docs/src/content/docs/(core)/oauth/notion.mdx Outdated
Comment thread docs/src/content/docs/(core)/oauth/pinterest.mdx Outdated
Comment thread docs/src/content/docs/(core)/oauth/strava.mdx Outdated
Comment thread docs/src/content/docs/(core)/oauth/twitch.mdx Outdated
Comment thread docs/tsconfig.json Outdated
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 11

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
docs/src/content/docs/(core)/integrations/next-app-router.mdx (1)

147-155: ⚠️ Potential issue | 🟠 Major | ⚡ Quick win

Sign-out example contradicts the documented cookie requirement.

The guide says sign-out responses must have Set-Cookie applied, but the server-action example redirects without showing that propagation step. Please align the example with the pitfall note (or update the pitfall text) to avoid incorrect implementations.

Also applies to: 248-248

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/src/content/docs/`(core)/integrations/next-app-router.mdx around lines
147 - 155, The sign-out server-action example (signOutAction) shows calling
api.signOut and immediately redirecting without demonstrating how the Set-Cookie
header from the sign-out response is propagated, which contradicts the
documented requirement that sign-out responses must apply Set-Cookie; update the
example to call api.signOut, extract the Set-Cookie header from the response
(from the headers returned by api.signOut), apply it to the outgoing response
(so the cookie is set for the client) before calling redirect("/home"), and/or
update the pitfall text to reflect the example’s behavior; ensure references to
signOutAction, api.signOut, headers(), Set-Cookie, and redirect are handled so
the cookie propagation step is explicit.
♻️ Duplicate comments (1)
docs/tsconfig.json (1)

17-17: ⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Remove deprecated baseUrl compiler option.

The baseUrl option is deprecated in TypeScript 6.x and will stop functioning in TypeScript 7.0. Since your paths mapping already includes the explicit prefix ("./src/*"), you can safely remove baseUrl without breaking module resolution.

Run the following script to verify the TypeScript version and check for any deprecation warnings:

#!/bin/bash
# Check TypeScript version and verify baseUrl usage
cd docs

echo "=== TypeScript version ==="
npx tsc --version

echo -e "\n=== Check for TS deprecation warnings ==="
npx tsc --noEmit 2>&1 | grep -i deprecat || echo "No deprecation warnings found"

echo -e "\n=== Verify `@/`* alias resolution without baseUrl ==="
rg -n '`@/`' --type=tsx --type=ts --glob '!node_modules' -C2 | head -20
✂️ Proposed fix to remove baseUrl
     "incremental": true,
-    "baseUrl": ".",
     "paths": {
       "`@/`*": ["./src/*"],
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/tsconfig.json` at line 17, Remove the deprecated "baseUrl" compiler
option from the tsconfig JSON: delete the "baseUrl": "." entry and leave the
existing "paths" mapping (e.g. "./src/*") intact so module resolution continues
to work; after removing "baseUrl" run TypeScript (npx tsc --version and npx tsc
--noEmit) and the provided alias-check commands to ensure there are no
deprecation warnings and that the "`@/`*" imports still resolve correctly.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/src/content/docs/`(core)/integrations/astro.mdx:
- Around line 6-7: Rewrite the opening paragraph in
docs/src/content/docs/(core)/integrations/astro.mdx for clarity: replace the
first sentence with "This guide walks you through implementing Aura Auth in an
Astro application." and simplify the second sentence to "If you haven't
configured Aura Auth yet, start with the Installation Guide and Quick Start
Guide to set up your Auth instance and environment variables, then follow the
steps below to integrate Aura Auth with your Astro application." Ensure links
remain intact.

In `@docs/src/content/docs/`(core)/integrations/bun.mdx:
- Around line 107-108: Update the stale "Configuration Reference" link target
that currently points to '/docs/configuration/options' so it points to the new
location '/docs/api-reference/options' (leave the "Configuration Reference" link
text and the "TypeScript Guide" link unchanged); locate the MDX entry where the
markdown link for "Configuration Reference" is defined and replace the URL
string accordingly.

In `@docs/src/content/docs/`(core)/integrations/cloudflare-workers.mdx:
- Line 6: Replace the grammatically incorrect sentence "This guide walks you
through to implement Aura Auth in a Cloudflare application to a complete
support." with a clear phrasing such as "This guide walks you through
implementing Aura Auth in a Cloudflare application to provide complete support."
— locate and update the exact sentence in the docs content so the intro reads
smoothly (the original sentence text is the unique identifier to find the line).

In `@docs/src/content/docs/`(core)/integrations/deno.mdx:
- Line 6: Update the introductory sentence that currently reads "This guide
walks you through to implement Aura Auth in the native Deno server to a complete
support" to a grammatically correct form; replace it with a clear phrase such as
"This guide walks you through implementing Aura Auth in a native Deno server for
full support" (or similar) so it uses the gerund "implementing" and replaces "to
a complete support" with "for full support" in the
docs/src/content/docs/(core)/integrations/deno.mdx introduction.
- Line 116: Update the Configuration Reference link target in
docs/src/content/docs/(core)/integrations/deno.mdx: locate the markdown link
text "[Configuration Reference]" and change its URL from
"/docs/configuration/options" to "/docs/api-reference/options" so it matches the
other integration guides and the restructured docs.

In `@docs/src/content/docs/`(core)/integrations/express.mdx:
- Around line 169-210: The docs import references the wrong middleware filename;
replace the import of verify-session.js with the actual module that exports
withAuth (e.g., change import { withAuth } from
"`@/middlewares/verify-session.js`" to import { withAuth } from
"`@/middlewares/with-auth`" (use the appropriate .ts/.js extension consistent with
the surrounding examples) and update any other occurrences in this doc to
reference with-auth so the documented symbol withAuth matches the real file
name.

In `@docs/src/content/docs/`(core)/integrations/next-app-router.mdx:
- Line 69: Typo fix: in the sentence that references the catch-all route string
`app/api/auth/[...aura]/route.ts`, replace the misspelled word "Rouetr" with
"Router" so the instruction reads "App Router" (ensure the surrounding sentence
remains intact and punctuation unchanged).

In `@docs/src/content/docs/`(core)/integrations/next-pages-router.mdx:
- Around line 65-67: Update the documentation to reference the correct Pages
Router API file path: replace any occurrences of
"pages/api/auth/[...aura]/route.ts" with "pages/api/auth/[...aura].ts" and
ensure the example snippet title `src/pages/api/auth/[...aura].ts` matches the
text; verify the /api/auth path guidance aligns with Pages Router conventions
and your Auth `basePath` setting.

In `@docs/src/content/docs/`(core)/integrations/nuxt.mdx:
- Around line 6-7: Rewrite the awkward intro sentence in
docs/src/content/docs/(core)/integrations/nuxt.mdx to improve grammar: replace
"This guide walks you through to implement Aura Auth in a Nuxt application to a
complete support for Nitro Server Engine." with a clearer phrasing such as "This
guide walks you through implementing Aura Auth in a Nuxt application with full
support for the Nitro Server Engine." so the intent and structure read
naturally.

In `@docs/src/content/docs/`(core)/integrations/react-router.mdx:
- Line 68: Fix the typo in the routing description sentence that currently reads
"App Rouetr Structure" by changing "Rouetr" to "Router" in the docs line that
says "Create a catch-all route in `src/routes/api.auth.$.tsx` to handle all
authentication endpoints dynamically. The `/api/auth` path should match with the
App Router Structure and `basePath` defined in your Auth configuration."

In `@docs/src/content/docs/`(core)/integrations/supabase-edge-functions.mdx:
- Line 6: Replace the grammatically incorrect sentence "This guide walks you
through to implement Aura Auth in a Supabase Edge Functions application with a
complete support." with a corrected version such as "This guide walks you
through implementing Aura Auth in a Supabase Edge Functions application with
complete support." — locate the sentence in
docs/src/content/docs/(core)/integrations/supabase-edge-functions.mdx and update
the paragraph accordingly.

---

Outside diff comments:
In `@docs/src/content/docs/`(core)/integrations/next-app-router.mdx:
- Around line 147-155: The sign-out server-action example (signOutAction) shows
calling api.signOut and immediately redirecting without demonstrating how the
Set-Cookie header from the sign-out response is propagated, which contradicts
the documented requirement that sign-out responses must apply Set-Cookie; update
the example to call api.signOut, extract the Set-Cookie header from the response
(from the headers returned by api.signOut), apply it to the outgoing response
(so the cookie is set for the client) before calling redirect("/home"), and/or
update the pitfall text to reflect the example’s behavior; ensure references to
signOutAction, api.signOut, headers(), Set-Cookie, and redirect are handled so
the cookie propagation step is explicit.

---

Duplicate comments:
In `@docs/tsconfig.json`:
- Line 17: Remove the deprecated "baseUrl" compiler option from the tsconfig
JSON: delete the "baseUrl": "." entry and leave the existing "paths" mapping
(e.g. "./src/*") intact so module resolution continues to work; after removing
"baseUrl" run TypeScript (npx tsc --version and npx tsc --noEmit) and the
provided alias-check commands to ensure there are no deprecation warnings and
that the "`@/`*" imports still resolve correctly.
🪄 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: defaults

Review profile: CHILL

Plan: Pro

Run ID: f3db7b12-767a-4d5c-87e8-67a894d35b58

📥 Commits

Reviewing files that changed from the base of the PR and between 97762ff and dbdf58f.

⛔ Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
📒 Files selected for processing (55)
  • docs/src/app/layout.tsx
  • docs/src/content/docs/(core)/(getting-started)/installation.mdx
  • docs/src/content/docs/(core)/(getting-started)/introduction.mdx
  • docs/src/content/docs/(core)/(getting-started)/quick-start.mdx
  • docs/src/content/docs/(core)/api-reference/meta.json
  • docs/src/content/docs/(core)/faq.mdx
  • docs/src/content/docs/(core)/guides/schema-validation.mdx
  • docs/src/content/docs/(core)/integrations/astro.mdx
  • docs/src/content/docs/(core)/integrations/bun.mdx
  • docs/src/content/docs/(core)/integrations/cloudflare-workers.mdx
  • docs/src/content/docs/(core)/integrations/deno.mdx
  • docs/src/content/docs/(core)/integrations/elysia.mdx
  • docs/src/content/docs/(core)/integrations/express.mdx
  • docs/src/content/docs/(core)/integrations/hono.mdx
  • docs/src/content/docs/(core)/integrations/meta.json
  • docs/src/content/docs/(core)/integrations/next-app-router.mdx
  • docs/src/content/docs/(core)/integrations/next-pages-router.mdx
  • docs/src/content/docs/(core)/integrations/nuxt.mdx
  • docs/src/content/docs/(core)/integrations/oak.mdx
  • docs/src/content/docs/(core)/integrations/react-router.mdx
  • docs/src/content/docs/(core)/integrations/supabase-edge-functions.mdx
  • docs/src/content/docs/(core)/integrations/tanstack-start.mdx
  • docs/src/content/docs/(core)/integrations/vercel-edge-functions.mdx
  • docs/src/content/docs/(core)/meta.json
  • docs/src/content/docs/(core)/oauth/atlassian.mdx
  • docs/src/content/docs/(core)/oauth/bitbucket.mdx
  • docs/src/content/docs/(core)/oauth/click-up.mdx
  • docs/src/content/docs/(core)/oauth/dropbox.mdx
  • docs/src/content/docs/(core)/oauth/github.mdx
  • docs/src/content/docs/(core)/oauth/gitlab.mdx
  • docs/src/content/docs/(core)/oauth/mailchimp.mdx
  • docs/src/content/docs/(core)/oauth/notion.mdx
  • docs/src/content/docs/(core)/oauth/pinterest.mdx
  • docs/src/content/docs/(core)/oauth/strava.mdx
  • docs/src/content/docs/(core)/oauth/twitch.mdx
  • docs/src/content/docs/examples/astro.mdx
  • docs/src/content/docs/examples/bun.mdx
  • docs/src/content/docs/examples/cloudflare-workers.mdx
  • docs/src/content/docs/examples/deno.mdx
  • docs/src/content/docs/examples/elysia.mdx
  • docs/src/content/docs/examples/express.mdx
  • docs/src/content/docs/examples/hono.mdx
  • docs/src/content/docs/examples/meta.json
  • docs/src/content/docs/examples/next-app-router.mdx
  • docs/src/content/docs/examples/next-pages-router.mdx
  • docs/src/content/docs/examples/nuxt.mdx
  • docs/src/content/docs/examples/oak.mdx
  • docs/src/content/docs/examples/react-router.mdx
  • docs/src/content/docs/examples/supabase-edge-functions.mdx
  • docs/src/content/docs/examples/tanstack-start.mdx
  • docs/src/content/docs/examples/vercel-edge-functions.mdx
  • docs/src/lib/cn.ts
  • docs/src/lib/merge-refs.ts
  • docs/src/mdx-components.tsx
  • docs/tsconfig.json
✅ Files skipped from review due to trivial changes (31)
  • docs/src/content/docs/(core)/api-reference/meta.json
  • docs/src/content/docs/examples/meta.json
  • docs/src/content/docs/examples/oak.mdx
  • docs/src/lib/merge-refs.ts
  • docs/src/mdx-components.tsx
  • docs/src/content/docs/(core)/integrations/meta.json
  • docs/src/lib/cn.ts
  • docs/src/content/docs/examples/nuxt.mdx
  • docs/src/content/docs/examples/tanstack-start.mdx
  • docs/src/content/docs/(core)/oauth/click-up.mdx
  • docs/src/content/docs/(core)/oauth/gitlab.mdx
  • docs/src/content/docs/(core)/integrations/vercel-edge-functions.mdx
  • docs/src/content/docs/examples/vercel-edge-functions.mdx
  • docs/src/content/docs/(core)/oauth/github.mdx
  • docs/src/content/docs/(core)/oauth/atlassian.mdx
  • docs/src/content/docs/(core)/oauth/dropbox.mdx
  • docs/src/content/docs/(core)/integrations/oak.mdx
  • docs/src/content/docs/examples/react-router.mdx
  • docs/src/content/docs/examples/next-pages-router.mdx
  • docs/src/content/docs/(core)/integrations/hono.mdx
  • docs/src/content/docs/(core)/oauth/strava.mdx
  • docs/src/content/docs/(core)/oauth/notion.mdx
  • docs/src/content/docs/examples/next-app-router.mdx
  • docs/src/content/docs/(core)/guides/schema-validation.mdx
  • docs/src/content/docs/(core)/integrations/elysia.mdx
  • docs/src/content/docs/(core)/oauth/pinterest.mdx
  • docs/src/content/docs/examples/express.mdx
  • docs/src/content/docs/examples/astro.mdx
  • docs/src/content/docs/(core)/meta.json
  • docs/src/content/docs/(core)/(getting-started)/quick-start.mdx
  • docs/src/content/docs/(core)/oauth/twitch.mdx

Comment thread docs/src/content/docs/(core)/integrations/astro.mdx Outdated
Comment thread docs/src/content/docs/(core)/integrations/bun.mdx Outdated
Comment thread docs/src/content/docs/(core)/integrations/cloudflare-workers.mdx Outdated
Comment thread docs/src/content/docs/(core)/integrations/deno.mdx Outdated
Comment thread docs/src/content/docs/(core)/integrations/deno.mdx
Comment thread docs/src/content/docs/(core)/integrations/next-app-router.mdx Outdated
Comment thread docs/src/content/docs/(core)/integrations/next-pages-router.mdx Outdated
Comment thread docs/src/content/docs/(core)/integrations/nuxt.mdx Outdated
Comment thread docs/src/content/docs/(core)/integrations/react-router.mdx Outdated
Comment thread docs/src/content/docs/(core)/integrations/supabase-edge-functions.mdx Outdated
@halvaradop halvaradop merged commit a22c366 into master May 24, 2026
7 checks passed
@halvaradop halvaradop deleted the docs/refine-docs-app branch May 24, 2026 19:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant