Docs Ingest Public Private Grill Status

Branch Dashboard

Glossary

Terms

• Public Documentation: Reader-facing product, usage, or domain documentation meant for users, adopters, or scaffold recipients.
• Private Documentation: Internal project, operator, maintenance, implementation, or planning documentation meant to preserve how the project is built and run.
• Docs Ingest Phase: The public Harness phase entrypoint that turns docs-affecting source material into routed documentation and bookkeeping.
• Writing Fragments: A public-doc authoring stage that gathers reusable claims, examples, snippets, raw copy, and source-backed material before page structure is chosen.
• Writing Beats: A public-doc authoring stage that orders the reader journey into narrative or instructional beats before final article structure.
• Writing Shape: A public-doc authoring stage that chooses the final page/article structure, section rhythm, and component pattern from the beats.
• Writer Artifacts: Durable private documentation artifacts produced by the public-doc writer flow before final public page output.
• Writer Artifact Bundle: A private per-target or per-pass folder containing fragments, beats, and shape outputs for one substantial public-doc effort.
• Docs Pack: The default distributed Harness skill pack that includes docs-ingest and public-doc writing primitives.

Relationships

• Docs Ingest Phase writes or updates Public Documentation and Private Documentation according to the target repo's docs architecture.
• Writing Fragments precede Writing Beats; Writing Beats precede Writing Shape; Writing Shape precedes final public article/page writing.
• Writer Artifacts live in Private Documentation and inform future Public Documentation passes.
• Writer Artifact Bundle contains Writing Fragments, Writing Beats, and Writing Shape for one target or pass.
• Delivery Phase calls Docs Ingest Phase after substantial implementation changes when docs-affecting behavior needs durable capture.
• Docs Pack includes Docs Ingest Phase, Writing Fragments, Writing Beats, and Writing Shape.

Axioms

• Preserve the existing private technical/project documentation architecture.
• Do not duplicate specs, plans, implementation notes, or runbooks into article pages.
• Do not create a second routed docs surface just because docs ingest ran.
• Harness Intelligence route names are examples, not portable scaffold standards.
• docs-ingest-phase must infer or use the target repo's domain-bounded docs architecture instead of hardcoding Harness Intelligence route names.
• Substantial new or rewritten public-facing documentation must pass through writing fragments -> writing beats -> writing shape -> final article/page.
• Small public-doc patches can skip writer stages only with an explicit no-op reason.
• Public writer flow does not replace spec ingestion.
• Public writer flow runs when public-facing pages are created or materially updated, including after delivery-phase calls docs-ingest-phase for substantial docs-affecting changes.
• Writer artifacts produced before final public pages are durable private documentation, not temporary scratch output.
• Writer artifacts should be organized as one private bundle per public-doc target or substantial docs pass.
• Writer artifact paths are repo-bounded; do not enforce a universal docs/public-docs prefix.
• When routed private docs exist, writer artifacts should be routed private pages; otherwise use source-only private files as a fallback.
• Private writer artifacts link to final public pages; final public pages do not visibly link back by default.
• writing-fragments, writing-beats, and writing-shape are separate reusable skills orchestrated by docs-ingest-phase.
• The default distributed docs pack includes docs-ingest-phase, writing-fragments, writing-beats, and writing-shape.

Flagged Ambiguities

• None currently active.