arborist/docs/_source/index.rst
russell@unturf.com 0aada29a8e
docs: arborist-one-pager + arborist-two-pager — Dav1d/fox-signoff summaries with letterhead, license, and 2 strategic appendix diagrams
1-pager (docs/_source/arborist-one-pager.rst, 1 page) for AI-literate readers: the trichotomy, the 8-dim cache key, CTI synthetic-elision-impossible, soft-channel separation, real-traffic bench numbers (mis-cite 100% @ 0% FP, warrant 92/92, quote 0.54 STRICT-rate).

2-pager (docs/_source/arborist-two-pager.rst, 3 pages = 2 body + 1 appendix) for technical reviewers: letterhead, Permacomputer Preamble license box, six numbered sections, plus appendix figures (pager-arch-stack 3-layer architecture, pager-verifier-flow question→pointer→verifier→trichotomy).

Both pages live under docs/_source/ so the same RST renders into the Sphinx readthedocs site (toctree caption "Summary pages" added to docs/_source/index.rst) AND into standalone PDFs via rst2pdf (docs/pager.style, lazy install into .venv).

Makefile targets: docs-one-pager, docs-two-pager, docs-pagers, docs-pagers-clean. Diagrams render through the existing DOT pipeline.
2026-05-14 09:48:50 -04:00

59 lines
816 B
ReStructuredText

Arborist API Reference
======================
Generated from docstrings. Replaces the static modules.md.
Contents:
.. toctree::
:maxdepth: 1
:caption: Summary pages
arborist-one-pager
arborist-two-pager
.. toctree::
:maxdepth: 2
:caption: Getting started
quickstart
concepts
cookbook
.. toctree::
:maxdepth: 2
:caption: Substrate
merkle-agi-dag-v7
merkle-agi-v7w-spatial-temporal
merkle-agi-v8-consensus
v8-fork-score
pi-star
bench
.. toctree::
:maxdepth: 3
:caption: API Modules
api/makefile
api/substrate
api/storage
api/retrieval
api/qa
api/distill
api/mesh
api/cli
.. toctree::
:maxdepth: 1
:caption: Project
license
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`