Docs Ingest Phase

Quick Start

docs-ingest-phase is a reusable docs router.

1. Read phases/router.md.
2. Inspect only enough source, diff, spec, notes, wiki, public docs, and root docs state to choose the current docs path.
3. Load exactly the one branch file the router selects.
4. Complete that path. When the resulting docs describe a complex flow, use $show-me to add the smallest useful visual view beside the authoritative prose; keep simple flows textual.
5. Write the docs-ingest outcome, then stop or re-enter docs-ingest-phase to route again.

Completion of one path does not imply loading another path.

Entry Modes

• Wiki setup/adoption: establish or adopt the project-owned wiki contract and report its readiness.
• Source capture: preserve and commit a supplied raw source with provenance.
• Wiki health: check and maintain the structure and truth of existing wiki knowledge.
• Private/internal ingest: durable capture for specs, project docs, wiki internals, legacy root docs/ merges, runbooks, operator workflow, routing metadata, or learning artifacts.
• Public docs: reader-facing product, usage, domain, command, onboarding, or changelog docs.
• Mixed docs: one change needs both private/internal capture and public-facing docs.
• No-op check: determine whether docs ingest is already complete or intentionally unnecessary.

Phase Files

• phases/router.md: choose the next docs path from artifacts and audience.
• references/wiki-contract.md: set up or adopt the wiki, sections Adopt or Set up.
• references/source-capture.md: capture a raw source the user supplies to keep.
• references/health.md: run a wiki health check or maintenance.
• phases/private-internal.md: ingest specs, project/wiki docs, root docs, routing metadata, and learning artifacts.
• phases/public-docs.md: create or update reader-facing docs through the public writer flow.

Router Rules

• Do not read path files other than router.md until the router selects them.
• Classify by audience first: internal/project/operator docs are private/internal; reader/adopter/scaffold-recipient docs are public.
• Use the repo's existing private and public docs surfaces. Do not create a second routed docs surface or hardcode Harness-specific route names in other repos.
• If both paths apply, prefer private/internal first when source capture, route policy, metadata, or durable writer artifact location is unresolved.
• Public docs work that runs the writer flow must include the fragment sufficiency checkpoint from phases/public-docs.md.
• After a path completes, report enough state for future resume: selected path, inputs processed, docs written or skipped, validation, blockers, and next path if any.

Project Verifier boundary

Treat Feature Maps as read-only navigation inputs to ordinary product and domain documentation. Preserve all Project Verifier references; docs ingest never creates, edits, regenerates, or maintains Feature Maps, invokes either verification lifecycle skill, or performs a verifier audit. Record observed coverage gaps for implement-spec to handle in its selected scenario.

Stop Conditions

• Selected path completed and its resumable outcome was reported.
• Router finds no docs-affecting change and reports a no-op reason.
• A wiki contract gap blocks the selected branch and its gap report is written.
• Required docs surface, route policy, source artifact, or user guidance is missing.
• Public fragment sufficiency checkpoint is waiting for the user's answer.