beffroi-tools/docs
Dandaedre 443c569d1c
Beffroi/beffroi-tools/pipeline/head This commit looks good Details
Link standalone PDF Presenter foundation and development guides
2026-11-19 12:13:54 +01:00
..
ascii-names Release v0.7.0 Midra workflow and CAD exchange milestone 2026-11-14 22:30:47 +01:00
canvas-pilot Move Canvas Pilot into its own repository and link its manual 2026-11-16 10:26:36 +01:00
development Move Canvas Pilot into its own repository and link its manual 2026-11-16 10:26:36 +01:00
exporter Release v0.7.0 Midra workflow and CAD exchange milestone 2026-11-14 22:30:47 +01:00
interfaces Move Canvas Pilot into its own repository and link its manual 2026-11-16 10:26:36 +01:00
manuals Move Canvas Pilot into its own repository and link its manual 2026-11-16 10:26:36 +01:00
media-player-classic Release v0.7.0 Midra workflow and CAD exchange milestone 2026-11-14 22:30:47 +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 Move Canvas Pilot into its own repository and link its manual 2026-11-16 10:26:36 +01:00
rundown-converter Release v0.7.0 Midra workflow and CAD exchange milestone 2026-11-14 22:30:47 +01:00
README.md Link standalone PDF Presenter foundation and development guides 2026-11-19 12:13:54 +01:00
changelogs.md Link standalone PDF Presenter foundation and development guides 2026-11-19 12:13:54 +01:00

README.md

Documentation

Project portal · Changelogs · Development

Read the full manuals → — searchable mdBook documentation for this repository’s five tools and the independently maintained Canvas Pilot.

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
Canvas Pilot Introduction · User guide Resolutions and cropping · Device checks · Plan
PDF Presenter Repository (access required; foundation only) Implementation plan · CI
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.