.agents/memory/2026-03-02-documentation-audit-update-plan-for-signetai.md

1.3 KiB

2026-03-02 Session Notes

Documentation Audit & Update Plan for signetai

Nicholai provided a comprehensive plan to bring documentation in sync with the active signetai codebase (v0.14.5). Prior audit work identified ~40K lines of existing docs that lag behind implementation by ~25 new API endpoints, several new packages, new pipeline stages, and configuration options.

The plan prescribes a 5-agent parallel strategy to audit source code and update documentation without blocking:

  • Agent A (Core Infrastructure): CLAUDE.md endpoint/package tables, docs/API.md, docs/ARCHITECTURE.md
  • Agent B (Pipeline & Config): docs/PIPELINE.md, docs/CONFIGURATION.md with new stages and config keys
  • Agent C (Features): docs/MCP.md, docs/SCHEDULING.md, docs/CONNECTORS.md expansion
  • Agent D (Surface): docs/SDK.md, docs/HARNESSES.md, docs/TRAY.md, docs/DASHBOARD.md
  • Agent E (Release): docs/CONTRIBUTING.md, root CONTRIBUTING.md, release workflow docs

Key gap areas: ~25 missing API endpoints (checkpoints, features, telemetry, analytics, repair actions), 5 missing packages (opencode-plugin, tray, predictor, harness, signet-memory-openclaw), 6 missing pipeline stages, thin/incomplete feature documentation.

All changes confined to docs/ and CLAUDE.md. Verification via grep and typecheck planned.