dtourolle/DarkRoom
1
0
Fork 0
Code Issues 39 Pull Requests Actions Packages Projects Releases 21 Wiki Activity

Point the docs index at the help sheet, the bundled manual and its page

Browse Source 
The index described the manual's contents as they were before colour
labels and the duplicates review, and did not say the application
carries the manual or where the in-app copy of the gesture book is
(Help or F1 in the grid, "?" or F1 in develop since d9f2596 and
380cfda). Its conventions named two generated files; manual/index.html
is a third, with its own CI check.
This commit is contained in:
dtourolle
2026-09-26 07:47:00 -04:00
parent 7c838691e9
commit 0103200fc5
1 changed files with 9 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/README.md
+9 -7
View File
@@ -7,8 +7,8 @@ second.
| | | | | |
|---|---| |---|---|
| [The manual](manual/README.md) | Every feature, pictured from the application itself — opening a library, rating and filing, developing, local masks, repair, film, panoramas, export | | [The manual](manual/README.md) | Every feature, pictured from the application itself — opening a library, rating, labelling and filing, duplicate originals, developing, local masks, repair, film, panoramas, export. The application carries it and opens it from Help and from Settings |
| [How it is driven](gestures.md) | Every gesture and shortcut, by screen. Generated from the code, so it cannot describe one the application does not have | | [How it is driven](gestures.md) | Every gesture and shortcut, by screen. Generated from the code, so it cannot describe one the application does not have. The same list is the in-app help sheet: `Help` or `F1` in the grid, `?` or `F1` in develop |
The [top-level README](../README.md) says what DarkRoom is, how to get it on The [top-level README](../README.md) says what DarkRoom is, how to get it on
each platform, and what is still missing. each platform, and what is still missing.
@@ -74,11 +74,13 @@ recollection.
## Conventions ## Conventions
Two files here are generated and must not be edited by hand: Three files here are generated and must not be edited by hand:
`gestures.md` and `dev/traceability.md`. Both come from `gestures.md`, `dev/traceability.md` and `manual/index.html`, the page the
`cargo run -p traceability` and the pre-commit hook keeps them in step with packages install, rendered from `manual/README.md`. All three come from
the tree. The manual's pictures are recorded by `cargo run -p traceability`, the pre-commit hook keeps them in step with the
[`tools/manual`](../tools/manual/README.md) and live in LFS. tree, and CI fails when one is not what the tree generates. The manual's
pictures are recorded by [`tools/manual`](../tools/manual/README.md) and live
in LFS.
A design document links to the requirements it satisfies and to the code A design document links to the requirements it satisfies and to the code
that satisfies them. When the code moves, the link moves with it; a document that satisfies them. When the code moves, the link moves with it; a document