Skip to content

Echo 1.0: Echo Docs Split Before Release #586

Description

@flyingrobots

Before Echo 1.0, split durable documentation out of the Echo code repository.

Doctrine

  • Echo repo answers: what builds, what is enforced, what must not drift?
  • Echo Docs answers: what does it mean, how do I understand it?
  • GitHub Issues answer: what work exists?
  • GitHub Milestones answer: what goalpost are we closing?
  • GitHub Projects answer: what is the operating view right now?

Required slices

  • Inventory repo docs by owner: code-coupled, public docs, historical design, tracking, delete.
  • Create echo-docs repository with license, README, publishing target, and cross-link policy.
  • Move public docs, narrative docs, diagrams, and historical design archive.
  • Replace moved docs in Echo with stubs only where inbound links require them.
  • Delete repo-local planning surfaces and backlog folders.
  • Add a docs drift guard that rejects static issue counts, task-list roadmaps, branch-status prose, and dead planning paths.
  • Update contributor workflow for code docs vs reader docs vs GitHub work tracking.

Exit criteria

  • Echo repo contains only code-coupled docs and stable engineering doctrine.
  • Echo Docs owns reader-facing and historical documentation.
  • Live planning is in GitHub Issues/Milestones/Projects.
  • Release docs point to the split correctly.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationfeatureFeature umbrella (epic)lane:releaseMethod lane release.legend:docsMethod legend docs.release:echo-1.0Echo 1.0 release convergence scopetype:maintenanceMethod work type maintenance.

    Projects

    Status
    Todo

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions