Context
This issue is part of the HAMi v2.9.0 Documentation Revamp Plan (WS1 - Documentation Migration & Structure).
The current docs/ directory has content but no clear information architecture. Pages are not consistently grouped by type. The goal is to establish a clean, scalable structure that separates conceptual content from operational guides and reference material.
Before you start
Please reach out to the maintainers before picking this up. This issue requires alignment on structure before any files are moved.
Scope
Design and implement a top-level documentation structure with the following four sections:
- Concepts: what HAMi is, how it works, core abstractions
- Architecture: control plane, data plane, component relationships
- Guides: installation, upgrade, uninstall, device-specific guides, quick start
- Reference: configuration options, API surface, troubleshooting
Tasks:
- Propose the new IA as a comment on this issue before touching any files
- Get approval from @rootsongjc
- Reorganize docs/ to match the approved structure
- Update sidebars.js to reflect the new navigation
- Add redirect entries in docusaurus.config.js for any moved pages to avoid broken links
- Verify the build passes with
npm run build
Acceptance criteria
- docs/ is organized into the four sections above
- sidebars.js reflects the new structure
- No broken links (existing URLs redirect to new paths)
- Build passes
- Chinese translation paths in i18n/zh/ are updated to match
Notes
- Do not move files before the IA proposal is approved
- DCO sign-off required on every commit (
git commit -s)
Context
This issue is part of the HAMi v2.9.0 Documentation Revamp Plan (WS1 - Documentation Migration & Structure).
The current docs/ directory has content but no clear information architecture. Pages are not consistently grouped by type. The goal is to establish a clean, scalable structure that separates conceptual content from operational guides and reference material.
Before you start
Please reach out to the maintainers before picking this up. This issue requires alignment on structure before any files are moved.
Scope
Design and implement a top-level documentation structure with the following four sections:
Tasks:
npm run buildAcceptance criteria
Notes
git commit -s)