docs: agent-facing documentation for sei-load#55
Conversation
Add a docs/ tree + root AGENTS.md index so a cluster of perf-benchmarking +
Sei-expert agents can autonomously configure, run, reproduce, and interpret
load experiments:
AGENTS.md (index) + docs/{01-mental-model, 02-running, 03-config-reference,
04-workload-model, 05-reproducibility, 06-measurement-metrics,
07-experiment-playbook, 08-limits-boundaries}.
Authored by matched experts grounded in source; cross-reviewed by a full
cohort (systems accuracy, Sei/EVM mechanism, OTel metrics+queries, agent
usability). Metric/PromQL names use the real exported wire names
(seiload_ namespace + unit suffixes). The StorageRW key/size/op contention
axes (§04, §07) are marked '(delivered by PLT-465)' — they parse but do not
affect generated txs on main until #54 lands.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
PR SummaryLow Risk Overview It introduces The README gets a banner directing agents to Docs repeatedly warn that on Reviewed by Cursor Bugbot for commit b6f9b15. Bugbot is set up for automated code reviews on this repo. Configure here. |
Comprehensive agent-facing documentation so a cluster of performance-benchmarking + Sei-expert agents can autonomously configure, run, reproduce, and interpret experiments with sei-load.
What
AGENTS.mdindex (entry point + reading order + fastest-path).docs/tree (8 sections): mental model (open-loop / coordinated omission; generator emits signals, verdicts are external), running, config reference, workload model (+ what the contention/size axes actually probe on Sei — block-stm/OCC, not DynamoDB-style throttling), reproducibility (seeded sub-streams, the honest determinism guarantee), measurement & metrics (exact emitted-series catalog + external-query guidance), experiment playbook (objective → knobs → run → interpret), limits & accepted boundaries.AGENTS.md.How it was built
Authored by matched experts grounded in source, then a full Coral cohort cross-review: systems-engineer (accuracy), sei-network-specialist (Sei mechanism), opentelemetry-expert (metric catalog + PromQL), prose-steward (agent-usability). Notable catches folded in: the PromQL examples now use the real
seiload_-prefixed wire names (the catalog was right but queries were querying base names → zero series), and a falseseiChainId'casing bug' claim was removed (Go binds case-insensitively — verified).§04/§07 document the StorageRW key/size/op contention axes, which are delivered by PLT-465 (#54, currently open) — on
mainthose config fields parse but don't affect generated txs. The docs mark this clearly; this PR should merge with or after #54 so the documented axes exist onmain.Docs-only; no code changes.
🤖 Generated with Claude Code