Reorder language guides and reposition category in docs nav#962
Conversation
Order guides auto-detected-first, then by relevance, with an esoteric tail. Move Language Guides and Recipes down to sit just above Reference, and turn Language Guides into a plain category with an Overview item instead of a landing-page link. MIR-1442
|
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)
📝 WalkthroughWalkthroughThe language guide table now reorders several Dockerfile.miren entries and adds JRuby and TruffleRuby. The documentation sidebar relocates the Language Guides and Recipes categories, adds an explicit Overview item, and reorganizes the guide document order into grouped sections. Comment |
![miren-code-agent[bot]](https://avatars.githubusercontent.com/u/174767976?s=60&v=4){kind=small}
There was a problem hiding this comment.
🍪 biscuit: ✅ ready to merge — auto-review, non-blocking
This is a clean documentation-only reorganization across two files. I checked it carefully:
What changed:
sidebars.ts— "Language Guides" moves from position 3 (right after Deploy) to near the bottom, sitting between "Miren Cloud" and "Recipes". The category'slink:property (which madeguides/indexthe category header) is replaced with an explicit'Overview'doc item as the first child — a reasonable and functionally equivalent swap; the index page stays reachable.docs/guides/index.md— The "Pick your language" table is reordered to match the new sidebar order: auto-detected stacks first (Python, JS, Go, Ruby, Rust), then Dockerfile-based languages roughly by relevance (Java, PHP, .NET, C++, C, Deno, Elixir, … down to the niche tail).
Consistency check: I enumerated both lists entry-by-entry. Every guide present in the markdown table is present in the sidebar and in the same relative order, with nothing added or dropped. The sidebar's 'Overview' item doesn't appear in the table (it's not a language, it's the index page itself), which is correct.
One minor thing to be aware of: removing the link: from the category means the category label in the sidebar is no longer itself a clickable link to the Overview page — readers have to expand the category and click "Overview". In Docusaurus this is expected behavior when link: is absent, so it's not a bug, just a UX trade-off. Given there's now an explicit "Overview" item as the first child, this seems intentional and fine.
No correctness issues, no missing entries, no broken structure. This is ready to merge.
🍪 full review note · comment /biscuit review to run biscuit again.
2 participants
Closes MIR-1442.
What
Language guides were in effectively random order, and the ~38-item category sat high in the left-nav dominating the top of the sidebar.
guides/index.mdtable now match): auto-detected stacks first (Python, JavaScript, Go, Ruby, Rust), then Dockerfile languages by rough relevance, with an esoteric tail (Klong, COBOL, Bash, Static).intro → getting-started → Deploy → Data & Storage → Networking & Security → Run & Scale → Miren Cloud → Language Guides → Recipes → Reference → Resources.link: {doc}; the index content now sits under an Overview item as the first entry (mirroring the Miren Cloud pattern).The page heading stays "Language Guides" for now.
Testing
bun run lintpasses.