38 lines
2.9 KiB
Markdown
38 lines
2.9 KiB
Markdown
# Documentation
|
|
|
|
[Project portal](../README.md) · [Changelogs](changelogs.md) · [Development](development/README.md)
|
|
|
|
**[Read the full manuals →](https://books.dandaedre.com/manuals/)** — searchable mdBook documentation for all six tools.
|
|
|
|
## Tools
|
|
|
|
| Tool | Start here | Reference and background |
|
|
| --- | --- | --- |
|
|
| PPTX Reporter | [Guide](pptx-reporter/README.md) · [Visual walkthrough](pptx-reporter/visual-guide.md) | [Report formats](pptx-reporter/report-formats.md) · [Windows quick start](pptx-reporter/windows-quickstart.txt) · [Portable quick start](pptx-reporter/portable-quickstart.txt) |
|
|
| Rundown Converter | [Guide](rundown-converter/README.md) · [Portable quick start](rundown-converter/portable-quickstart.txt) | [Corpus findings](rundown-converter/corpus.md) · [Plan](rundown-converter/plan.md) |
|
|
| Canvas Pilot | [Introduction](canvas-pilot/README.md) · [User guide](canvas-pilot/guide/README.md) | [Resolutions and cropping](canvas-pilot/resolutions.md) · [Device checks](canvas-pilot/device-check.md) · [Plan](canvas-pilot/plan.md) |
|
|
| ASCII Names | [Guide](ascii-names/README.md) | [Changelog](ascii-names/changelog.md) |
|
|
| Document Exporter | [Guide](exporter/README.md) | [Changelog](exporter/changelog.md) |
|
|
| MPC-HC Companion | [Setup and development](../companion-modules/media-player-classic/README.md) | [Changelog](media-player-classic/changelog.md) |
|
|
|
|
## Shared resources
|
|
|
|
- **mdBook manuals:** [read online](https://books.dandaedre.com/manuals/) · [build, local preview and Jenkins publication](manuals/README.md).
|
|
|
|
- **Development:** [setup and checks](development/README.md), [CI and coverage](development/ci.md), [builds and portable releases](development/releases.md), [application artwork](development/releases.md#application-artwork).
|
|
- **File and device contracts:** [interface index](interfaces/README.md), including versioned examples and compatibility rules.
|
|
- **Starter files:** [Canvas Pilot catalog](templates/canvas-pilot/README.md), with Full HD and 4K base files in all nine exchange formats.
|
|
- **Release history:** [v0.7.0 notes](releases/v0.7.0.md), [v0.6.0 notes](releases/v0.6.0.md), [v0.3.0 notes](releases/v0.3.0.md) and [per-tool changelogs](changelogs.md).
|
|
- **Future work:** [ideas](../Ideas.md), [program task list](planning/program-task-list.md), [Flipper Link feasibility](planning/flipper-link.md).
|
|
|
|
## Where documentation belongs
|
|
|
|
Keep each tool's guide, plans, screenshots and changelog in its named folder.
|
|
Shared contributor instructions live in `development/`, historical release notes
|
|
in `releases/`, and cross-tool research in `planning/`. The Companion setup guide
|
|
stays beside its module source.
|
|
|
|
Keep save/export contracts and their versioned examples in `interfaces/`, and
|
|
reusable starter documents in `templates/`. These files are also used by tests;
|
|
update incoming links and code or packaging references whenever a document moves.
|