Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Greptile SummaryThis PR adds a new welcome page (
Confidence Score: 5/5Safe to merge; all findings are P2 documentation link quality improvements that do not affect functionality. Both issues are minor documentation link concerns — a duplicate href and an inconsistent GitHub URL. Neither blocks user paths in a critical way: the REST API overview is a valid landing point, and the GitHub link discrepancy is a cosmetic navigation concern. All findings are P2. docs-mintlify/index.mdx — verify the GitHub repo URL and the Server API link destination. Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[Welcome Page] --> B[Hero Banner]
A --> C[Quick Start Steps]
A --> D[Navigate Through Docs]
A --> E[Resources]
C --> C1[Setup]
C --> C2[Add Auth UI]
C --> C3[Read User Data]
C --> C4[REST API]
D --> D1[Getting Started]
D --> D2[Components]
D --> D3[SDK Reference]
D --> D4{Then pick your path}
D4 --> D5[Going Further]
D4 --> D6[Apps]
D4 --> D7[REST API]
E --> E1[Dashboard]
E --> E2[GitHub]
E --> E3[Discord]
|
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
There was a problem hiding this comment.
Pull request overview
Updates the Mintlify docs welcome page to present onboarding/navigation content in a more guided, “recommended order + branching paths” layout.
Changes:
- Reworked the hero section container styling (full-width breakout → rounded, constrained layout).
- Replaced the “Explore the Docs / Common Tasks” card grids with a timeline-style recommended reading order and branching sections.
- Expanded the “Explore Apps” area into a larger set of app entry points.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
📝 WalkthroughWalkthroughReworked Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 1 | ❌ 2❌ Failed checks (2 inconclusive)
✅ Passed checks (1 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 |
![vercel[bot]](https://avatars.githubusercontent.com/in/8329?s=60&v=4){kind=small}
![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
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs-mintlify/index.mdx (1)
26-37:⚠️ Potential issue | 🟡 MinorBoth CTA buttons link to the same URL.
The "Start setup" and "Browse docs" buttons both point to
/guides/getting-started/setup. The "Browse docs" button should likely link to a different destination (e.g.,/docs/overviewor an anchor to the navigation section below).Proposed fix
<a href="/guides/getting-started/setup" - className="inline-flex items-center justify-center rounded-lg border border-slate-600 px-5 py-3 text-sm font-semibold text-slate-200 no-underline transition hover:border-[`#6346ec`] hover:text-white" + className="inline-flex items-center justify-center rounded-lg border border-slate-600 px-5 py-3 text-sm font-semibold text-slate-200 no-underline transition hover:border-[`#6346ec`] hover:text-white" + href="#navigate-through-our-docs" > Browse docs </a>Or link to a docs overview page instead of the setup guide.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs-mintlify/index.mdx` around lines 26 - 37, The two anchor elements for the CTAs both point to "/guides/getting-started/setup"; update the second anchor (the one with text "Browse docs" and className containing "border border-slate-600") to use the correct docs URL (e.g., "/docs/overview" or an in-page anchor) instead of the setup path so each button navigates to its intended destination.
🧹 Nitpick comments (1)
docs-mintlify/index.mdx (1)
51-69: Update Quick Start links to use consistent/docs/path pattern.Lines 53, 60, 63, and 66 use old-style paths (
/guides/...,/sdk/...,/api/...), while the rest of the page uses the/docs/...pattern. Update these for consistency:
- Line 53, 60: Change
/guides/getting-started/setupto/docs/getting-started/setup- Line 63: Change
/sdk/overviewto/docs/sdk/overview- Line 66: Change
/api/overviewto/docs/rest-api/overview(note: rest-api, not api)Also consider adding redirects in
docs-mintlify/docs.jsonif the old paths will no longer be available.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs-mintlify/index.mdx` around lines 51 - 69, Update the Quick Start link targets inside the Steps/Step blocks: change the two occurrences of "/guides/getting-started/setup" (in the Step titled "Set up Stack Auth" and the Step titled "Add auth UI") to "/docs/getting-started/setup", change "/sdk/overview" (in the Step titled "Read user data in code") to "/docs/sdk/overview", and change "/api/overview" (in the Step titled "Go lower-level when needed") to "/docs/rest-api/overview"; after updating these link hrefs, add corresponding redirects for the old paths in docs.json so existing links keep working.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs-mintlify/index.mdx`:
- Around line 151-155: The "Client API" and "Server API" anchor elements
currently both use href="/docs/rest-api/overview"; update the href on the anchor
with text "Server API" to the correct server-docs route (e.g., the distinct
server API overview path in your docs site) so it no longer points to the same
URL as the "Client API" link, and verify the new URL resolves correctly in the
site navigation; keep the "Client API" href unchanged if that is the intended
client page.
- Around line 161-173: The Card components inside CardGroup use incorrect hrefs
under /docs/apps/...; update each Card's href to the correct /guides/... routes
(e.g., change the Card with title "Authentication" href "/docs/apps/oauth" to
"/guides/apps/authentication/overview", "Auth Providers" to
"/guides/apps/authentication/auth-providers", "API Keys" to
"/guides/apps/api-keys/overview", "Analytics" to
"/guides/apps/analytics/overview", "Teams" (title "Teams") to
"/guides/apps/teams/overview", and adjust "Permissions" (title "Permissions") to
the RBAC route "/guides/apps/rbac/overview" if appropriate; also verify and
correct the "Data Vault" card href to the proper guides path) so each Card.title
maps to the correct guides URL.
---
Outside diff comments:
In `@docs-mintlify/index.mdx`:
- Around line 26-37: The two anchor elements for the CTAs both point to
"/guides/getting-started/setup"; update the second anchor (the one with text
"Browse docs" and className containing "border border-slate-600") to use the
correct docs URL (e.g., "/docs/overview" or an in-page anchor) instead of the
setup path so each button navigates to its intended destination.
---
Nitpick comments:
In `@docs-mintlify/index.mdx`:
- Around line 51-69: Update the Quick Start link targets inside the Steps/Step
blocks: change the two occurrences of "/guides/getting-started/setup" (in the
Step titled "Set up Stack Auth" and the Step titled "Add auth UI") to
"/docs/getting-started/setup", change "/sdk/overview" (in the Step titled "Read
user data in code") to "/docs/sdk/overview", and change "/api/overview" (in the
Step titled "Go lower-level when needed") to "/docs/rest-api/overview"; after
updating these link hrefs, add corresponding redirects for the old paths in
docs.json so existing links keep working.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (2)
docs-mintlify/index.mdx (2)
177-177:⚠️ Potential issue | 🟠 MajorPoint “Auth Providers” at a registered docs page.
/guides/apps/authentication/auth-providersis not listed as a standalone page indocs-mintlify/docs.json:70-100; it is only therootof the nested "All Auth Providers" group, with the actual docs living under provider-specific routes. This card should link to a real page or be backed by a new overview page at that path.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs-mintlify/index.mdx` at line 177, The "Auth Providers" Card in docs-mintlify/index.mdx points to /guides/apps/authentication/auth-providers which is not a registered standalone page; either update the Card's href in docs-mintlify/index.mdx (the Card with title "Auth Providers") to point to an actual provider page (e.g., an existing provider route under the auth-providers group) or create a new overview page at /guides/apps/authentication/auth-providers and add it to docs-mintlify/docs.json so the path is registered; ensure the Card href and docs.json entry match exactly.
42-53:⚠️ Potential issue | 🟡 MinorDifferentiate the secondary hero CTA.
Line 49 sends “Browse docs” to the same
/guides/getting-started/setuppage as “Start setup” on Line 43, so the secondary action does not actually browse. Point it at a broader docs entry point/section anchor, or rename it to match the setup destination.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs-mintlify/index.mdx` around lines 42 - 53, The secondary CTA anchor with text "Browse docs" currently points to the same href as the primary "Start setup", so update the anchor (the <a> element whose inner text is "Browse docs" and className starting with "inline-flex items-center ... border") to either point to a broader docs entry (e.g. change href to "/docs" or "/guides") or, if you intend it to remain the setup destination, rename its visible text to match (e.g. "Open setup"); adjust only the href or text in that specific anchor so the two CTAs are distinct.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs-mintlify/index.mdx`:
- Around line 118-120: The ChipLink labeled "UserButton" currently points to the
hook docs at href="/sdk/hooks/use-user"; update this to either retarget the link
to the correct component page or rename the chip to match the hook (e.g., change
the label to "useUser"). Locate the ChipLink instance with label "UserButton"
and adjust its href to the component route for UserButton or change its
displayed text to "useUser" so the label and destination match.
---
Duplicate comments:
In `@docs-mintlify/index.mdx`:
- Line 177: The "Auth Providers" Card in docs-mintlify/index.mdx points to
/guides/apps/authentication/auth-providers which is not a registered standalone
page; either update the Card's href in docs-mintlify/index.mdx (the Card with
title "Auth Providers") to point to an actual provider page (e.g., an existing
provider route under the auth-providers group) or create a new overview page at
/guides/apps/authentication/auth-providers and add it to docs-mintlify/docs.json
so the path is registered; ensure the Card href and docs.json entry match
exactly.
- Around line 42-53: The secondary CTA anchor with text "Browse docs" currently
points to the same href as the primary "Start setup", so update the anchor (the
<a> element whose inner text is "Browse docs" and className starting with
"inline-flex items-center ... border") to either point to a broader docs entry
(e.g. change href to "/docs" or "/guides") or, if you intend it to remain the
setup destination, rename its visible text to match (e.g. "Open setup"); adjust
only the href or text in that specific anchor so the two CTAs are distinct.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
This PR is for the Welcome page in Mintlify docs.
Summary by CodeRabbit