Guidedog / Documentation 0.2.0

Download the process and the registry as a PDF

Guidedog Discussions

A design record explains a decision and its consequences. It names the assumptions, the alternatives, and the evidence.

Read the state first. A proposal is not an accepted design. A Git commit is not the GDS state committed.

This is a separate documentation project from the manual. The manual teaches use. These records explain the design.

The process

• Work on a discussion

  • Create and inspect

  • Review and promote

  • Record a decision

  • Publish and recover

• Discussion registry

• Discussion reading order

  • The Guidedog Discussion Process

  • Guidedog: CLI and documentation toolchain

  • Guidedoc: Odin conversion engine

  • Memory budgets and what a build may read

  • An Odin domain and Odin API documentation

  • Sphinx-style projects and recoverable publication

• Historical provenance

  • The Zen Discussion Process

  • Historical registry

  • Historical export manifest