4.5 KiB
Agent documentation
Start with AGENTS.md for working rules and the conversation handoff for dated context and pending decisions. Verify current code, Git and external state before acting on old notes. This index links authoritative records; it does not duplicate their content.
Planning and project history
- Development entry point.
- Implementation, to-do, acceptance tests and stretch goals.
- Book and application localization roadmap.
- Future adapter research and documentation ranking.
- Completed Aquilon support task.
- Feature demonstration/recording checklist.
- Migration provenance and completeness audit.
- Changelog.
Contracts and compatibility
Versioned examples and sanitized fixtures remain beside their contracts and in
crates/canvas-pilot/tests/fixtures/; regression tests refer to these paths.
| Contract | Scope |
|---|---|
| Project | Project schema, versions and migrations |
| Settings | User preferences and settings compatibility |
| Theme packs | Runtime palette ZIPs, installation, updates and fallback |
| Language packs | Runtime ZIP catalogs, installation and fallback |
| Recovery | Recovery storage and restoration |
| Layer clipboard | Versioned geometry, crop, fit and blanking payload |
| Geometry exchange | Precision, omissions and round trips |
| Extra parameters | Embedded project snapshots |
| Device adapters | Shared representation and family-specific behavior |
| Device import | Read-only import and conversion |
| Device send | Reviewed writes, preflight, quantization and readback |
| Input previews | Capture and cache behavior |
| Desktop launchers | Generated shortcut and bundle formats |
| Persistence audit | Coverage of persistent state |
Research, evidence and validation notes
- Hardware verification record.
- Aquilon compatibility investigation and emulator evidence.
- Practical Midra aspect acceptance checklist.
- Fit precision and mask-rasterization questions for engineers.
- Resolution and crop model, also a user-book reference.
- Viewport performance reproduction.
- Screenshot provenance and capture recipes.
- Historical visual proposals: A, B, C.
- Icon-generation provenance.
Build and documentation maintenance
- CI, validation commands and publication boundaries.
- Release preparation and no-build readiness findings.
- Book generation and publication, chapter list and book configuration.
- User-book introduction source, chapter overview and template catalog.
The book owns user-facing explanations. Development owns the task-list entry point. Agent notes, handoffs and contracts are reached through this index and are not book chapters. Preserve useful cross-references and source documents; generated HTML is not a second editable source. Historical migration inventories describe their audit date, not a promise that documentation filenames can never change.