beffroi-tools/docs
Dandaedre 3dff673d0d Document Aquilon protocol differences and adapter implementation plan 2026-11-15 11:40:45 +01:00
..
ascii-names Release v0.7.0 Midra workflow and CAD exchange milestone 2026-11-14 22:30:47 +01:00
development Build and publish project mdBook manuals through Jenkins 2026-11-14 20:44:11 +01:00
exporter Release v0.7.0 Midra workflow and CAD exchange milestone 2026-11-14 22:30:47 +01:00
interfaces Remember four recent Midra connections for quick switching 2026-11-15 11:36:33 +01:00
manuals Document Aquilon protocol differences and adapter implementation plan 2026-11-15 11:40:45 +01:00
media-player-classic Release v0.7.0 Midra workflow and CAD exchange milestone 2026-11-14 22:30:47 +01:00
midra-layout Document Aquilon protocol differences and adapter implementation plan 2026-11-15 11:40:45 +01:00
planning Organize documentation by tool and update references 2026-11-14 17:57:06 +01:00
pptx-reporter Release v0.7.0 Midra workflow and CAD exchange milestone 2026-11-14 22:30:47 +01:00
releases Release v0.7.0 Midra workflow and CAD exchange milestone 2026-11-14 22:30:47 +01:00
rundown-converter Release v0.7.0 Midra workflow and CAD exchange milestone 2026-11-14 22:30:47 +01:00
templates/midra-layout Use Craft CAD codecs for QCAD-compatible DXF and DWG exchange 2026-11-14 22:16:06 +01:00
README.md Release v0.7.0 Midra workflow and CAD exchange milestone 2026-11-14 22:30:47 +01:00
changelogs.md Release v0.7.0 Midra workflow and CAD exchange milestone 2026-11-14 22:30:47 +01:00

README.md

Documentation

Project portal · Changelogs · Development

Read the full manuals → — searchable mdBook documentation for all six tools.

Tools

Tool Start here Reference and background
PPTX Reporter Guide · Visual walkthrough Report formats · Windows quick start · Portable quick start
Rundown Converter Guide · Portable quick start Corpus findings · Plan
Midra Layout Introduction · User guide Resolutions and cropping · Device checks · Plan
ASCII Names Guide Changelog
Document Exporter Guide Changelog
MPC-HC Companion Setup and development Changelog

Shared resources

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.