arborist/docs/_source/index.rst
russell@unturf.com da0d79d29e
docs: re-org nav so theory doesn't overwhelm practitioners
The Substrate group is Dav1d's formal Merkle-AGI research that drove the
design — valuable, but it sat third in the nav and read like required
reading. IA-only fix (no content touched):
- re-caption 'Substrate' -> 'Substrate theory (advanced)' + a preamble
  marking it optional (nothing in Getting started / API depends on it);
- reorder it BELOW the practical sections (now: Summary -> Getting started
  -> API -> Substrate theory -> Project);
- pull 'bench' out of Substrate into Getting started (it's the practical
  benchmark surface, not theory).
Practitioner path comes first; theory stays intact + credited, just last.
2026-05-21 17:29:01 -04:00

69 lines
1.2 KiB
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
google-l5-rag-10m
.. toctree::
:maxdepth: 2
:caption: Getting started
quickstart
concepts
cookbook
bench
.. toctree::
:maxdepth: 3
:caption: API Modules
api/makefile
api/substrate
api/storage
api/retrieval
api/qa
api/distill
api/mesh
api/cli
Substrate theory (advanced)
---------------------------
The pages below formalize the **Merkle-AGI substrate** that drove
arborist's design and business logic (the research line behind the
tickets and code). They are **optional for users** — nothing in *Getting
started* or the *API* depends on them. Read them only if you want the
formal model.
.. toctree::
:maxdepth: 2
:caption: Substrate theory (advanced)
merkle-agi-dag-v7
merkle-agi-v7w-spatial-temporal
merkle-agi-v8-consensus
v8-fork-score
pi-star
.. toctree::
:maxdepth: 1
:caption: Project
license
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`