diff --git a/docs/README.md b/docs/README.md index 00456a5..ca93560 100644 --- a/docs/README.md +++ b/docs/README.md @@ -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 | -| [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 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. 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 each platform, and what is still missing. @@ -74,11 +74,13 @@ recollection. ## Conventions -Two files here are generated and must not be edited by hand: -`gestures.md` and `dev/traceability.md`. Both come from -`cargo run -p traceability` and the pre-commit hook keeps them in step with -the tree. The manual's pictures are recorded by -[`tools/manual`](../tools/manual/README.md) and live in LFS. +Three files here are generated and must not be edited by hand: +`gestures.md`, `dev/traceability.md` and `manual/index.html`, the page the +packages install, rendered from `manual/README.md`. All three come from +`cargo run -p traceability`, the pre-commit hook keeps them in step with the +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 that satisfies them. When the code moves, the link moves with it; a document