-
Notifications
You must be signed in to change notification settings - Fork 2.6k
wip: PoC docs sidebar restructure #33933
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
wip: PoC docs sidebar restructure #33933
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
✅ Deploy Preview for nx-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
9942175 to
a13e201
Compare
|
View your CI Pipeline Execution ↗ for commit 3dcda74
☁️ Nx Cloud last updated this comment at |
Co-authored-by: barbados-clemens <[email protected]>
- Simplify getting started flow: Introduction → Start New → Add Existing → Local Dev - Merge editor-setup and ai-setup into single local-development page - Add global install preamble to start-new-project and start-with-existing-project - Move nx-cloud intro to guides/Nx Cloud section - Move install-non-javascript to reference section - Move update-global-installation to troubleshooting section - Curate Concepts section to only include core concepts: - Mental Model, How Caching Works, Task Pipelines, Inferred Tasks, Nx Plugins - Update all internal links to reflect new page locations URL changes requiring redirects: - /docs/getting-started/installation → /docs/getting-started/start-new-project - /docs/getting-started/editor-setup → /docs/getting-started/local-development - /docs/getting-started/ai-setup → /docs/getting-started/local-development - /docs/getting-started/nx-cloud → /docs/guides/nx-cloud/intro - /docs/guides/installation/install-non-javascript → /docs/reference/install-non-javascript - /docs/guides/installation/update-global-installation → /docs/troubleshooting/update-global-installation
Build with Nx: - Flatten Core section - features now at top level - Remove CI Basics nested wrapper - Add Nx MCP to features section - Add Maintain TypeScript Monorepos to TypeScript technology section Scale with Nx: - Flatten CI Features (8 items at top level) - Add Module Boundaries section (moved from guides) - Add Conformance section (moved from reference) - Add Owners section (moved from reference) Reference: - Remove Conformance, Owners, Nx MCP (moved to other sections) - Update sidebar middleware to inject packages dynamically Also: - Move Tips-n-Tricks files to appropriate locations - Update all internal links to new paths - Add URL redirects tracking for Phase 2
4d1304f to
c96fb1b
Compare
Move Run Tasks, Cache Task Results, Explore the Graph, and Generate Code from Build with Nx to Learn Nx > Concepts for better discoverability. Reorder Concepts section for logical learning progression: 1. Mental Model - foundational overview 2. Nx Plugins - what enables everything 3. Inferred Tasks - how plugins configure tasks 4. Run Tasks - first action 5. Explore the Graph - visualize workspace 6. Task Pipelines - understand task ordering 7. Cache Task Results - enable caching 8. How Caching Works - deep dive 9. Generate Code - scaffolding
7c8b920 to
3dcda74
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nx Cloud is proposing a fix for your failed CI:
We fixed broken documentation links caused by the sidebar restructure. The PR moved conformance and owners documentation from /docs/reference/ to /docs/scale-with-nx/, but some internal links still referenced the old paths. We also added breadcrumb parent URLs to the ignore list since Starlight auto-generates these navigation links without corresponding index pages.
We could not verify this fix.
Warning
The suggested diff is too large to display here, but you can view it on Nx Cloud ↗
Or Apply changes locally with:
npx nx-cloud apply-locally 0DIZ-97f8
Apply fix locally with your editor ↗ View interactive diff ↗
🎓 Learn more about Self-Healing CI on nx.dev
how can we better bucket our information into logical chunks 🤔