docs: reconcile nav with filesystem and tidy sidebar#1976
Conversation
The docs site sidebar had drifted out of sync with the pages on disk, which read as unmaintained. Reconcile the two and smooth over a few consistency rough edges: - Add sidebar entries for pages that existed but were unlinked: moq-mux and moq-boy crates, @moq/demo and @moq/boy packages, and the CMAF standard. moq-mux was even featured on the homepage yet absent from the sidebar. - Fix the C library "libmoq" link, which jumped into the Rust crates section (switching the whole sidebar) instead of staying in /lib/c/. - Promote the orphaned /demo/ folder to a first-class nav + sidebar section, rename Setup's overlapping "Demos" subsection to "Demo Setup" so the two stop colliding, and point the homepage "Demo" hero button back into the docs instead of off to moq.dev. - Unify labels: capitalize well-known tech in the Layers list (QUIC, WebTransport, WebSocket) while keeping project literals (moq-lite, hang), and rename the navbar "Apps" to match the "Applications" page title it links to. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01QBqk5qwpJmbcWQdDnxNZ4w
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Sorry @kixelated, you have reached your weekly rate limit of 500000 diff characters.
Please try again later or upgrade to continue using Sourcery
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
WalkthroughThis change updates the VitePress documentation site configuration and home page. Top navigation labels are updated (“Apps” to “Applications”, new “Demos” entry), and sidebar entries are adjusted: the setup sidebar’s “Demos” label becomes “Demo Setup”, concept sidebar link casing is standardized for QUIC, WebTransport, and WebSocket, and a new CMAF standard link is added. Library sidebars gain new Rust and TypeScript package entries (moq-mux, moq-boy, 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches✨ Simplify code
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 |
2 participants
Summary
The docs are asking "is there a better way to organize this so it's less hodge-podge and more professional?" The top-level structure (Setup / Concepts / Applications / Libraries) is actually solid. What made it feel unpolished was a layer of drift and inconsistency underneath it. This PR fixes the clearly-correct issues; voice/prose tone is intentionally left untouched pending a separate call.
Sidebar had drifted out of sync with the pages on disk
Several pages existed but were unreachable from the nav (nothing signals "unmaintained" faster):
moq-muxandmoq-boy(Rust crates) —moq-muxwas even featured on the homepage yet missing from the sidebar.@moq/demoand@moq/boy(JS packages).CMAFstandard under Concepts → Standards.Fixed a broken sidebar link
The C library's
libmoqentry linked to/lib/rs/crate/libmoq, which yanked the reader out of the C section and into Rust (switching the whole sidebar). It now stays in/lib/c/.De-orphaned the
/demo/section/demo/had a real overview + a substantive MoQ Boy architecture page, but nothing in the nav pointed to it, and the homepage "Demo" button left the docs site entirely formoq.dev./demo/to a first-class nav + sidebar section.Unified labels
quic→QUIC,web-transport→WebTransport,web-socket→WebSocket) while keeping project literals (moq-lite,hang).Deliberately not in this PR
Homepage prose/voice cleanup (e.g. the lone 🦀 on "Rust Crates", casual asides) is a taste call and left for a follow-up.
Test plan
vitepress buildcompletes with no dead-link errors..mdfile.🤖 Generated with Claude Code
(Written by Claude Opus 4.8)
Generated by Claude Code