docs/adapters
adapters docs guide
This section has three tracks:
Pages in this section
Start with the section hub, then move sideways into adjacent pages when you need more detail.
This directory preserves material that is useful for context but is not the source of truth for current package behavior.
wiki/docs/adapters/archive/README.md
This directory is the canonical contract for current @a5c-ai/adapters behavior.
wiki/docs/adapters/reference/README.md
The adapters family has pervasive naming inconsistencies across 42 packages, 8 binaries, and 3,500+ source references. This directory documents every gap and the target naming convention.
wiki/docs/adapters/terminology-and-structure-gaps/README.md
Use these guides when you want to accomplish a concrete @a5c-ai/adapters task and do not need the full normative reference first.
wiki/docs/adapters/tutorials/README.md
adapters docs
This section has three tracks:
- Reference — the canonical API and behavior contract for
@a5c-ai/adapters - Tutorials — task-oriented walkthroughs and usage guides
- Archive — historical comparisons, design proposals, research, and superseded planning material
Source of truth
reference/ is the normative source of truth for current @a5c-ai/adapters behavior.
If a tutorial or archived document conflicts with a reference page, the reference page wins.
Start here
- Package users: start with Reference
- First-time users: start with Getting Started, then confirm details in Reference
- Historical context, parity notes, and exploratory design work: see Archive
Publishing contract
reference/defines current behavior and API surfacetutorials/is discoverable but non-normativearchive/is preserved for context and is not source-of-truth
The main docs site consumes these markdown files directly. Keep the track boundaries explicit.