diff --git a/README.md b/README.md index d8a126d..e62b198 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ Portable releases · Quick start · Documentation · - Manuals · + Full manuals · What's new · Development

@@ -26,14 +26,14 @@

PPTX Reporter

Inspect presentation videos, read playback timings, and export reports or Ontime rundowns.

Desktop app · CLI

-

Visual walkthrough · Guide · Report formats

+

Full manual · Visual walkthrough · Guide · Report formats

Rundown Converter icon

Rundown Converter

Turn spreadsheet rundowns into Ontime schedules, with timing checks before export.

Desktop app · CLI

-

Guide · Sample findings

+

Full manual · Guide · Sample findings

@@ -42,14 +42,14 @@

Midra Layout

Arrange screen layers, exchange geometry, and review transfers to an Eikos 4K device.

Desktop app

-

Guide · Templates · Geometry formats

+

Full manual · Guide · Templates · Geometry formats

ASCII Names icon

ASCII Names

Clean up filenames to ASCII with paced renames, collision protection, and unchanged file contents.

Desktop app · CLI

-

Guide

+

Full manual · Guide

@@ -58,14 +58,14 @@

Document Exporter

Export PPTX to PDF or slide images, render PDF pages, and compress PDFs to a target size.

Python CLI

-

Guide and dependencies

+

Full manual · Guide and dependencies

MPC-HC Companion icon

MPC-HC Companion

Control Media Player Classic Home Cinema from Companion with playback actions and player feedback.

Companion 5.1 module

-

Setup and development

+

Full manual · Setup and development

diff --git a/companion-modules/media-player-classic/README.md b/companion-modules/media-player-classic/README.md index c6ecb00..e434f75 100644 --- a/companion-modules/media-player-classic/README.md +++ b/companion-modules/media-player-classic/README.md @@ -1,5 +1,7 @@ # MPC-HC Companion module — local development +[Read the full manual →](https://books.dandaedre.com/manuals/media-player-classic/) + Media Player Classic module icon A local development port of the original Media Player Classic module for diff --git a/docs/README.md b/docs/README.md index 2586cef..c590733 100644 --- a/docs/README.md +++ b/docs/README.md @@ -2,6 +2,8 @@ [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 | @@ -15,7 +17,7 @@ ## Shared resources -- **mdBook manuals:** [all six manuals, local preview and Jenkins publication](manuals/README.md). +- **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. diff --git a/docs/ascii-names/README.md b/docs/ascii-names/README.md index 0f69219..d504347 100644 --- a/docs/ascii-names/README.md +++ b/docs/ascii-names/README.md @@ -1,5 +1,7 @@ # ASCII names +[Read the full manual →](https://books.dandaedre.com/manuals/ascii-names/) + [Documentation](../README.md) · [Changelog](changelog.md) Application icon diff --git a/docs/ascii-names/changelog.md b/docs/ascii-names/changelog.md index 787a085..8b763c5 100644 --- a/docs/ascii-names/changelog.md +++ b/docs/ascii-names/changelog.md @@ -4,6 +4,8 @@ ## Unreleased +- Add direct links to the published mdBook manual from the project README, tool guide and documentation indexes. + - Add an mdBook manual built from the existing guides, with local assets and downloads. Jenkins publishes successful main builds under `/mnt/books/manuals/`; staging, link validation and scoped publication have regression coverage. - Use absolute Gitea main-branch URLs for repository file links in the root README; verify linked files exist. diff --git a/docs/exporter/README.md b/docs/exporter/README.md index e61ef5f..7fd8530 100644 --- a/docs/exporter/README.md +++ b/docs/exporter/README.md @@ -1,5 +1,7 @@ # Export presentations and PDF pages +[Read the full manual →](https://books.dandaedre.com/manuals/exporter/) + [Documentation](../README.md) · [Changelog](changelog.md) Application icon diff --git a/docs/exporter/changelog.md b/docs/exporter/changelog.md index 56d8455..d6078d7 100644 --- a/docs/exporter/changelog.md +++ b/docs/exporter/changelog.md @@ -4,6 +4,8 @@ ## Unreleased +- Add direct links to the published mdBook manual from the project README, tool guide and documentation indexes. + - Add an mdBook manual built from the existing guides, with local assets and downloads. Jenkins publishes successful main builds under `/mnt/books/manuals/`; staging, link validation and scoped publication have regression coverage. - Use absolute Gitea main-branch URLs for repository file links in the root README; verify linked files exist. diff --git a/docs/manuals/README.md b/docs/manuals/README.md index c7ac3c1..0892fbe 100644 --- a/docs/manuals/README.md +++ b/docs/manuals/README.md @@ -2,22 +2,24 @@ [Documentation](../README.md) · [CI and coverage](../development/ci.md) +**[Read all manuals online →](https://books.dandaedre.com/manuals/)** + Each project has an mdBook manual, built from the existing documentation. Edit the original guides; the build stages them without creating a second maintained copy. The published landing page includes all six project icons and manual links. -| Manual | Contents | Published directory | +| Manual | Read online | Chapter sources | | --- | --- | --- | -| ASCII Names | [Chapter list](ascii-names/SUMMARY.md) | `/mnt/books/manuals/ascii-names/` | -| Document Exporter | [Chapter list](exporter/SUMMARY.md) | `/mnt/books/manuals/exporter/` | -| MPC-HC Companion | [Chapter list](media-player-classic/SUMMARY.md) | `/mnt/books/manuals/media-player-classic/` | -| Midra Layout | [Chapter list](midra-layout/SUMMARY.md) | `/mnt/books/manuals/midra-layout/` | -| PPTX Reporter | [Chapter list](pptx-reporter/SUMMARY.md) | `/mnt/books/manuals/pptx-reporter/` | -| Rundown Converter | [Chapter list](rundown-converter/SUMMARY.md) | `/mnt/books/manuals/rundown-converter/` | +| ASCII Names | [Full manual](https://books.dandaedre.com/manuals/ascii-names/) | [Chapter list](ascii-names/SUMMARY.md) | +| Document Exporter | [Full manual](https://books.dandaedre.com/manuals/exporter/) | [Chapter list](exporter/SUMMARY.md) | +| MPC-HC Companion | [Full manual](https://books.dandaedre.com/manuals/media-player-classic/) | [Chapter list](media-player-classic/SUMMARY.md) | +| Midra Layout | [Full manual](https://books.dandaedre.com/manuals/midra-layout/) | [Chapter list](midra-layout/SUMMARY.md) | +| PPTX Reporter | [Full manual](https://books.dandaedre.com/manuals/pptx-reporter/) | [Chapter list](pptx-reporter/SUMMARY.md) | +| Rundown Converter | [Full manual](https://books.dandaedre.com/manuals/rundown-converter/) | [Chapter list](rundown-converter/SUMMARY.md) | -The landing page is `/mnt/books/manuals/index.html`. The books assume the books -server exposes that directory as `/manuals/`; each `book.toml` declares the -corresponding `site-url` for its 404 page. No public hostname is hardcoded. +The published site is served from `/mnt/books/manuals/` at +https://books.dandaedre.com/manuals/. Each `book.toml` declares a relative +`site-url` for its 404 page, so local previews also work. ## Build and preview diff --git a/docs/media-player-classic/changelog.md b/docs/media-player-classic/changelog.md index 2f0bb71..5e1a92f 100644 --- a/docs/media-player-classic/changelog.md +++ b/docs/media-player-classic/changelog.md @@ -4,6 +4,8 @@ ## Unreleased +- Add direct links to the published mdBook manual from the project README, tool guide and documentation indexes. + - Add an mdBook manual built from the existing guides, with local assets and downloads. Jenkins publishes successful main builds under `/mnt/books/manuals/`; staging, link validation and scoped publication have regression coverage. - Use absolute Gitea main-branch URLs for repository file links in the root README; verify linked files exist. diff --git a/docs/midra-layout/README.md b/docs/midra-layout/README.md index f062eda..f45c468 100644 --- a/docs/midra-layout/README.md +++ b/docs/midra-layout/README.md @@ -1,5 +1,7 @@ # Midra Layout +[Read the full manual →](https://books.dandaedre.com/manuals/midra-layout/) + Midra Layout icon Midra Layout helps you prepare screen layouts for presentations and live events. diff --git a/docs/midra-layout/changelog.md b/docs/midra-layout/changelog.md index d973a08..e414167 100644 --- a/docs/midra-layout/changelog.md +++ b/docs/midra-layout/changelog.md @@ -4,6 +4,8 @@ ## Unreleased +- Add direct links to the published mdBook manual from the project README, tool guide and documentation indexes. + - Mark PPTX, draw.io and SVG format acceptance as solved following the user's confirmation that all three work (2026-11-14). - Replace the incomplete DXF skeleton with the official shared Craft DXF document writer/reader; add optional Craft DWG exchange with the same pixel geometry and canvas limits. Refresh CAD starter files and cover document structure, binary DXF and DWG round trips. Add a byte-preserving ZIP of the AI templates to bypass Gitea/browser PDF preview downloads. diff --git a/docs/pptx-reporter/README.md b/docs/pptx-reporter/README.md index c39d399..a231973 100644 --- a/docs/pptx-reporter/README.md +++ b/docs/pptx-reporter/README.md @@ -1,5 +1,7 @@ # PPTX reporter +[Read the full manual →](https://books.dandaedre.com/manuals/pptx-reporter/) + [Documentation](../README.md) · [Changelog](changelog.md) · [Visual walkthrough](visual-guide.md) · [Report formats](report-formats.md) Application icon diff --git a/docs/pptx-reporter/changelog.md b/docs/pptx-reporter/changelog.md index 0de2cc1..409af12 100644 --- a/docs/pptx-reporter/changelog.md +++ b/docs/pptx-reporter/changelog.md @@ -4,6 +4,8 @@ ## Unreleased +- Add direct links to the published mdBook manual from the project README, tool guide and documentation indexes. + - Add an mdBook manual built from the existing guides, with local assets and downloads. Jenkins publishes successful main builds under `/mnt/books/manuals/`; staging, link validation and scoped publication have regression coverage. - Use absolute Gitea main-branch URLs for repository file links in the root README; verify linked files exist. diff --git a/docs/rundown-converter/README.md b/docs/rundown-converter/README.md index 2b672b9..797517d 100644 --- a/docs/rundown-converter/README.md +++ b/docs/rundown-converter/README.md @@ -1,5 +1,7 @@ # Rundown converter +[Read the full manual →](https://books.dandaedre.com/manuals/rundown-converter/) + [Documentation](../README.md) · [Changelog](changelog.md) · [Corpus findings](corpus.md) · [Plan](plan.md) Application icon diff --git a/docs/rundown-converter/changelog.md b/docs/rundown-converter/changelog.md index 13fb9fe..80e89bd 100644 --- a/docs/rundown-converter/changelog.md +++ b/docs/rundown-converter/changelog.md @@ -4,6 +4,8 @@ ## Unreleased +- Add direct links to the published mdBook manual from the project README, tool guide and documentation indexes. + - Add an mdBook manual built from the existing guides, with local assets and downloads. Jenkins publishes successful main builds under `/mnt/books/manuals/`; staging, link validation and scoped publication have regression coverage. - Use absolute Gitea main-branch URLs for repository file links in the root README; verify linked files exist.