About this manual
=================

This manual describes the implemented tool and its deliberate limits.
The separate GDS project records proposals, decisions, and review history.
A proposal's state is not changed by making its typography better.

The organization follows a practical documentation pattern:
learn with tutorials, understand with topic guides, act with practical tasks,
and check details in reference pages. Internals explain the invariants and proofs.

The prose favors small examples, named assumptions, and direct statements.
The aim is an explanation that another person can test.
The design uses restrained color, strong headings, serif reading text,
and accessible navigation. It does not imitate an author's words or layout.

This project was created with ``guidedog quickstart`` and is built by Guidedog.
RST holds the prose. Graphviz holds the diagrams. LaTeX math notation holds equations.
Typst remains only where a PDF typesetting template is required.

Build evidence
--------------

The remote validation on 2026-10-01 ran clean and incremental HTML and PDF
builds for CPython, Django, and Flask. All twelve commands succeeded.
Diagnostic and link results matched the established baseline.
There were 1,039 passing Linux tests and 94 passing targeted sanitizer tests.
That is evidence for the tested checkout. It is not a claim of complete Sphinx compatibility.
See :doc:`compatibility` for the retained limitations.

Documentation maintenance commands are in :doc:`howto/maintain-docs`.