Skip to content

docs: split 550-line README.adoc into a thin README + docs/ pages #82

Description

@hyperpolymath

Debt: Documentation (MEDIUM)

Source: docs/tech-debt-2026-05-26.md §3

README.adoc is 550 lines and has grown to do the work of a docs/ tree. A docs/ directory already exists (AI_INSTALLATION_GUIDE.adoc, OS_INTEGRATION.adoc, BT-PRESENCE-PLAN.adoc, CITATIONS.adoc, governance/), so this is a split-and-relocate, not a greenfield task.

Proposed work

  • Reduce README.adoc to a thin landing page: one-paragraph overview, quickstart, badges, and links into docs/.
  • Move the deep content into focused pages, e.g. docs/architecture.adoc, docs/usage.adoc, docs/build.adoc.
  • Cross-link from the thin README.

Heavy-wiki exemplars to copy structure from

affinescript, boj-server, echidna, hypatia.

Already resolved (no action)

  • The audit also flagged a missing CHANGELOG.md; one now exists (40 lines), so that sub-item is closed.

Severity: MEDIUM. Informational audit; closing the debt is maintainer follow-up.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions