beffroi-tools/docs
Dandaedre c9880a5aeb
Beffroi/beffroi-tools/pipeline/head This commit looks good Details
Simplify layer import review and destination scopes
2026-11-14 21:35:43 +01:00
..
ascii-names Build and publish project mdBook manuals through Jenkins 2026-11-14 20:44:11 +01:00
development Build and publish project mdBook manuals through Jenkins 2026-11-14 20:44:11 +01:00
exporter Build and publish project mdBook manuals through Jenkins 2026-11-14 20:44:11 +01:00
interfaces Simplify layer import review and destination scopes 2026-11-14 21:35:43 +01:00
manuals Build and publish project mdBook manuals through Jenkins 2026-11-14 20:44:11 +01:00
media-player-classic Build and publish project mdBook manuals through Jenkins 2026-11-14 20:44:11 +01:00
midra-layout Simplify layer import review and destination scopes 2026-11-14 21:35:43 +01:00
planning Organize documentation by tool and update references 2026-11-14 17:57:06 +01:00
pptx-reporter Build and publish project mdBook manuals through Jenkins 2026-11-14 20:44:11 +01:00
releases Release v0.6.0 Midra Layout milestone 2026-11-14 18:08:22 +01:00
rundown-converter Build and publish project mdBook manuals through Jenkins 2026-11-14 20:44:11 +01:00
templates/midra-layout Create visual Midra quick start and topic guides 2026-11-14 20:32:30 +01:00
README.md Build and publish project mdBook manuals through Jenkins 2026-11-14 20:44:11 +01:00
changelogs.md Organize documentation by tool and update references 2026-11-14 17:57:06 +01:00

README.md

Documentation

Project portal · Changelogs · Development

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.