Documentation roadmap
The 0.3.0 documentation covers the public control surfaces, HTTP contract,
model compatibility boundary, and primary libmir lifecycle. Later passes
will deepen these areas without changing their URLs.
Product guides
- screenshot-led TUI pages for Dashboard, Models, Chat, and Settings;
- screenshot-led web pages for search, load preflight, chat, images, settings, and cancellation;
- complete environment-variable reference;
- model configuration file reference;
- recovery and troubleshooting decision trees;
- platform-specific source build guides.
Developer reference
- generated item links to docs.rs for each public
libmirtype; - progress event and generation metrics field reference;
- error taxonomy and recovery guidance;
- concurrent session and throughput patterns;
- complete image preparation example;
- explicit Metal and CUDA policy tables;
- migration notes for each pre-1.0 release.
Integration policy
Tool-specific integration pages will be added only after an end-to-end test against MiRMiR 0.3.x. A configurable OpenAI base URL alone is not enough to claim full compatibility.