docs: define Docusaurus IA, sidebar structure, and i18n layout#63
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Restructures Docusaurus documentation by replacing the autogenerated sidebar with an explicit 9-section information architecture, adds an Advanced Cookbook placeholder page (zh-Hans + en), updates all _category_.json labels/positions/descriptions, and synchronizes the i18n current.json translation files to match the new sidebar category keys.
Changes:
- Rewrite
sidebars.jswith explicit logical category grouping (Quick Start, Advanced Cookbook, Components, Tools, Infrastructure, OSS Update Mode, Utilities, Guides, Release Log) - Add new
Advanced cookbook.mdplaceholder in root docs and mirror in both i18n locales - Update
_category_.jsonfiles (labels, positions, descriptions) and rewritecurrent.jsontranslations in both locales to match the new sidebar category IDs
Reviewed changes
Copilot reviewed 18 out of 18 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| website/sidebars.js | Replaces autogenerated sidebar with explicit 9-category structure |
| website/docs/quickstart/Advanced cookbook.md | New placeholder cookbook page (zh) |
| website/docs/quickstart/category.json | Renames "Quik start" → "Quick Start", updates description |
| website/docs/guide/category.json | Renames "Guide" → "Guides", position 7 |
| website/docs/doc/category.json | Renames "Doc" → "Components", position 2 |
| website/docs/releaselog/category.json | Renames "Release log" → "Release Log", position 8 |
| website/i18n/en/.../quickstart/Advanced cookbook.md | English translation of new cookbook |
| website/i18n/en/.../{quickstart,guide,doc,releaselog}/category.json | English category metadata mirroring root |
| website/i18n/en/.../current.json | Replaces old category translations with new keys |
| website/i18n/zh-Hans/.../quickstart/Advanced cookbook.md | Chinese version of new cookbook |
| website/i18n/zh-Hans/.../{quickstart,guide,doc,releaselog}/category.json | Chinese category metadata mirroring root |
| website/i18n/zh-Hans/.../current.json | Replaces old category translations with new keys |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| items: [ | ||
| 'quickstart/Quik start', | ||
| 'quickstart/Sample UI', | ||
| 'quickstart/Beginner cookbook', |
Comment on lines
+6
to
+15
| * Pages are grouped by role: | ||
| * 1. Quick Start & Cookbooks — first-time user flow and advanced production guides | ||
| * 2. Components — non-firmware component reference (Core, Bowl, | ||
| * Differential, Drivelution, Extension) | ||
| * 3. Tools — GeneralUpdate.Tools usage and artifact reference | ||
| * 4. Infrastructure — server-side services (Spacestation, Hub, ClientCore) | ||
| * 5. OSS Update Mode — OSS-based update flows (.NET & MAUI) | ||
| * 6. Utilities — shared helpers (GeneralTracer) | ||
| * 7. Guides — operational / platform-specific guides | ||
| * 8. Release Log — changelog and roadmap |
Comment on lines
1
to
+2
| /** | ||
| * Creating a sidebar enables you to: | ||
| - create an ordered group of docs | ||
| - render a sidebar for each doc of that group | ||
| - provide next/previous navigation | ||
|
|
||
| The sidebars can be generated from the filesystem, or explicitly defined here. | ||
|
|
||
| Create as many sidebars as you want. | ||
| * @ts-check |
JusterZhu
force-pushed
the
docs/issue-46-ia-layout
branch
from
8d40dd4 to
4bf4049
Compare
JusterZhu
force-pushed
the
docs/issue-46-ia-layout
branch
from
4bf4049 to
e0a25df
Compare
- Rewrite sidebar.js with explicit logical grouping (Quick Start, Components, Tools, Infrastructure, OSS, Utilities, Guides, Release Log) - Add advanced cookbook placeholder structure with chapter outline - Update _category_.json labels and descriptions for all sections - Sync i18n current.json sidebar translations for zh-Hans and English - Mirror all _category_.json files in both i18n locale directories Closes #46 Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
JusterZhu
force-pushed
the
docs/issue-46-ia-layout
branch
from
e0a25df to
3d2d853
Compare
This was referenced Jun 3, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #46
Summary
Page tree (sidebar sections)
Validation