Skip to content

Consolidate user and developer documentation before merge #39

Description

@frankischilling

Part of #13

What to build

Consolidate lasting user and developer documentation into the repository wiki, README, and CTXT manuals before the bootstrap branch merges. Preserve useful technical decisions and operating details from docs/, ADRs, AGENTS.md, and CONTEXT.md, while removing agent instructions, planning notes, stale progress narratives, and other material that does not belong in product documentation.

The resulting documentation must explain CupidC, CupidASM, CupidDis, CupidLD, CupidObj, CupidBuild, CTool, bootstrap seeds, supported builds, artifact publication, the filesystem, and important runtime behavior. Use readable Markdown structure instead of long undivided paragraphs. Apply the humanizer workflow to new and rewritten prose without changing technical claims.

Acceptance criteria

  • Inventory the durable facts, contracts, limitations, and troubleshooting information in docs/, ADRs, AGENTS.md, and CONTEXT.md.
  • Map each retained topic to the wiki, README, or a CTXT manual and identify its intended audience.
  • Fully document every Cupid Toolchain component and the relationships between them.
  • Add CupidBuild to the wiki and CTXT manuals, including its trust, coordination, validation, rollback, and publication responsibilities.
  • Preserve historical or architectural information needed by developers without retaining agent-only workflow text.
  • Remove duplicated, stale, planning-only, and agent-oriented material after its useful information has been migrated and reviewed.
  • Remove or reduce docs/, ADR, agent, and context files only after coverage checks show that required information exists in the destination documentation.
  • Use headings, tables, examples, and short lists where they improve navigation.
  • Run the humanizer workflow over all added or substantially rewritten prose, preserving commands, hashes, specifications, and citations.
  • Check links, CTXT generation, wiki rendering, and documentation references from a clean checkout.

Blocked by

This work starts after the self-hosting bootstrap is complete and must finish before the bootstrap branch merges to main.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    post-bootstrapRequired after self-hosting bootstrap completes and before merging to mainwayfinder:taskTask ticket that advances a wayfinder map

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions