Справочник¶
Справочник API для Agate — это rustdoc, сгенерированный из исходного кода крейтов. Каждый публичный тип, трейт и функция документированы в месте определения, так что rustdoc всегда синхронен с кодом.
Соберите документацию API локально¶
Это откроет сгенерированную документацию для каждого крейта рабочего пространства:
agate-crypto(crate agate_crypto) — стратегии и фабрики хеш / подпись / AEAD.agate-audit(crate agate_audit) — агрегат журнала прозрачности, порты и адаптеры.agate-proxy(crate agate_proxy) — домен инспекции и адаптер AG-UI.agate-policy(crate agate_policy) — домен политик (InspectedAction→PolicyDecision).agate-server(crate agate_server) — корень композиции.
С чего начать чтение
Начните с документации модуля верхнего уровня каждого крейта (lib.rs),
которая даёт абзац-ориентир и ссылки в слоистые модули. Страницы
Архитектуры отражают эту структуру в прозе.
Гейт CI запускает just doc, поэтому документация, которая не собирается
(битые внутридок-ссылки и т.д.), ломает сборку — rustdoc остаётся достоверным.
Размещённый rustdoc
Размещение сгенерированного rustdoc рядом с этим сайтом (например, по пути
/api/) запланировано. До тех пор генерируйте его локально командой выше.