canvas-pilot/AGENT_DOCUMENTATION.md

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

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

Build and documentation maintenance

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.