Skip to content

[docs/migration] Define and implement documentation IA (Concepts / Architecture / Guides / Reference) #417

@mesutoezdil

Description

@mesutoezdil

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:

  1. Propose the new IA as a comment on this issue before touching any files
  2. Get approval from @rootsongjc
  3. Reorganize docs/ to match the approved structure
  4. Update sidebars.js to reflect the new navigation
  5. Add redirect entries in docusaurus.config.js for any moved pages to avoid broken links
  6. 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)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions