Skip to content

[docs/diagram] Audit and clean up mindmaps across the repository #414

@mesutoezdil

Description

@mesutoezdil

Context

This issue is part of the HAMi v2.9.0 Documentation Revamp Plan (WS5 - Mindmap Audit).

The repository contains mindmaps that were created at various points in time. Some may be outdated, redundant, or misaligned with the current architecture and terminology. Before new content is written, these should be reviewed and cleaned up.

Before you start

Please reach out to the maintainers before picking this up:

Scope

  1. Locate all mindmaps in the repository (check docs/, blog/, static/, i18n/, versioned_docs/)
  2. For each mindmap, assess:
    • Is the content still accurate relative to current HAMi architecture?
    • Is it referenced from any documentation page?
    • Does it duplicate content covered elsewhere?
  3. Produce a short audit summary as a comment on this issue or a PR with the following actions taken:
    • Remove mindmaps that are outdated and not referenced
    • Update mindmaps that are mostly correct but contain stale terminology
    • Flag mindmaps that require architectural input before they can be updated

Acceptance criteria

  • Every mindmap in the repository has been reviewed
  • Outdated or orphaned mindmaps are removed
  • Updated mindmaps use current terminology and architecture
  • A brief audit summary is included in the PR description

Notes

  • If a mindmap requires significant redesign, open a separate issue rather than blocking this one
  • 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