Skip to content
beam-agents
GitHub

Repository reference docs

The reference documents under docs/ that have no dedicated page here yet, each with what it covers and where it is published.

PartialPartly implemented. The page states what is missing.

The repository carries a second documentation tree under docs/, built with mkdocs and published at ardada2468.github.io/beam-agents. It is the reference layer: exhaustive, versioned with the code, and written for someone already inside the codebase. This site is the explanatory layer.

Some of those documents already have a page here — errors, metrics, traces, the effector, testing and CI, the memory stores, and the YAML provider. The rest are listed below rather than summarized, because a summary that drifts is worse than a link that does not.

DocumentCovers
docs/index.mdThe reference tree's own entry point.
docs/api.mdThe public surface, name by name, as frozen for 1.0.
docs/batching.mdBatch policies, including the adaptive policy and whole-batch suspension.
docs/providers.mdThe LLMClient protocol and the shipped model providers.
docs/replay.mdThe replay bundle format and the replay CLI.
docs/sharding.mdKey sharding and what it costs.
docs/state-compat.mdWhat keyed state promises across a version hop.
docs/state-migration.mdThe migration chain walk and how a step is written.
docs/security.mdIntent signing, transport auth, and secret handling.
docs/continuous_eval.mdEvaluating an agent continuously against live traffic.
docs/releasing.mdThe compatibility surface and the release procedure.

Not yet implemented

This page is marked partial on purpose: it is an index, not coverage. Each row above is a document that has earned a page on this site and does not have one yet. The site's own verifier is what keeps the list honest — a new document under docs/ fails the build until some page here names it, and this page is where it lands until it gets a better home.

What backs this page

Source
docs/api.md
Source
docs/batching.md
Source
docs/benchmarks.md
Source
docs/providers.md
Source
docs/continuous_eval.md
Source
docs/index.md
Source
docs/releasing.md
Source
docs/replay.md
Source
docs/security.md
Source
docs/sharding.md
Source
docs/state-compat.md
Source
docs/state-migration.md
Specification
openspec/specs/repo-scaffolding/spec.md
Test
tests/docs/test_fidelity_checks.py