Skip to content

docs: move Quick Start to top-level after Prerequisite#613

Open
ymc9 wants to merge 1 commit into
mainfrom
docs/move-quick-start-toplevel
Open

docs: move Quick Start to top-level after Prerequisite#613
ymc9 wants to merge 1 commit into
mainfrom
docs/move-quick-start-toplevel

Conversation

@ymc9
Copy link
Copy Markdown
Member

@ymc9 ymc9 commented Jun 3, 2026

Summary

Relocates the Quick Start guide from the ORM section to a top-level doc, positioned right after Prerequisite in the sidebar.

Changes

  • git mv docs/orm/quick-start.md docs/quick-start.md
  • Set its sidebar_position to 3 and fixed paths for the new location:
    • imports ../_components/…./_components/…
    • CLI reference link ../reference/cli./reference/cli
  • Shifted the categories/docs previously at positions 3–13 down by one (modeling→4, orm→5, service→6, utilities→7, studio→8, recipe→9, reference→10, community-packages→11, samples→12, migrate-prisma→13, migrate-v2→14)

Resulting order: Overview → Prerequisite → Quick Start → Data Modeling → ORM → …

No internal markdown links referenced the old /orm/quick-start route, so nothing else needed updating.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Reorganized documentation sidebar page ordering across multiple guides.
    • Updated internal documentation reference paths and component imports for improved consistency.

Relocate the Quick Start guide from the ORM section to a top-level
doc positioned right after Prerequisite. Fix its relative imports and
the CLI reference link, and shift the following sidebar positions down
by one to make room.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@vercel
Copy link
Copy Markdown

vercel Bot commented Jun 3, 2026

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

Project Deployment Actions Updated (UTC)
zenstack-new-site Ready Ready Preview, Comment Jun 3, 2026 2:40am

Request Review

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jun 3, 2026

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: 43d19916-ee91-4d82-ae00-5161b3343b99

📥 Commits

Reviewing files that changed from the base of the PR and between 9a62157 and eb7962d.

⛔ Files ignored due to path filters (6)
  • docs/modeling/_category_.yml is excluded by !**/*.yml
  • docs/orm/_category_.yml is excluded by !**/*.yml
  • docs/recipe/_category_.yml is excluded by !**/*.yml
  • docs/reference/_category_.yml is excluded by !**/*.yml
  • docs/service/_category_.yml is excluded by !**/*.yml
  • docs/utilities/_category_.yml is excluded by !**/*.yml
📒 Files selected for processing (6)
  • docs/community-packages.md
  • docs/migrate-prisma.md
  • docs/migrate-v2.md
  • docs/quick-start.md
  • docs/samples.md
  • docs/studio.md

Walkthrough

This PR reorders the Docusaurus documentation sidebar by incrementing sidebar_position values across five documentation pages and updates component imports and reference links in quick-start.md to align with the new directory structure.

Changes

Documentation sidebar reordering and path updates

Layer / File(s) Summary
Sidebar position updates across documentation pages
docs/community-packages.md, docs/studio.md, docs/migrate-prisma.md, docs/samples.md, docs/migrate-v2.md
Sidebar position frontmatter values are incremented by 1 across five documentation pages (community-packages: 10→11, studio: 7→8, migrate-prisma: 12→13, samples: 11→12, migrate-v2: 13→14) to reorder them in the Docusaurus sidebar.
Import and reference path updates in quick-start.md
docs/quick-start.md
MDX import paths are updated from ../_components/... to ./_components/... for embedded components, and documentation reference links are updated from ../reference/... to ./reference/... to use new local module paths.

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 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 describes the main change: moving Quick Start documentation to top-level after Prerequisite, which is the primary objective of this PR.
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 docs/move-quick-start-toplevel

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.

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