Documentation
Browse the published documentation: https://ponchia.github.io/bronto-annotations/docs/ The interactive placement playground and actual rendered adapter examples are on the product website.
Use this page to distinguish the maintained package contract from dated incubation evidence and future work.
Current
- Repository README: product boundary, package surface, and consumer quick start.
- Context quick start: use annotations in a host context.
- API reference: public models and helpers.
- API stability: compatibility policy.
- Compatibility: supported environments and adapters.
- Integration recipes: host integration examples.
- Accessibility, performance, and release: maintained quality and release contracts.
The source tree, exports, tests, and generated package artifacts remain the authority when reference prose disagrees.
Decisions
Accepted decisions live under adr/. They explain why the package is a
standalone product and do not replace current API documentation.
Evidence and proposals
Files named dogfood-*, *-report, *-proof, *-plan, and *-roadmap are
dated evaluation evidence or proposals. They are not current API contracts.
Keep these plans source-dated, or move them under docs/archive/ when they no longer
inform an open decision.
Lifecycle
- Current guides change with the code they describe.
- Generated/reference material changes through its owning generator.
- Historical evaluations remain frozen evidence.
- Open plans are proposals, not claims that a feature is absent.