An error occurred while fetching this tab.
Add mdbook setup for documentation
- Dec 12, 2024
-
-
David Runge authoredSigned-off-by:David Runge <dvzrv@archlinux.org>
-
David Runge authored
Signed-off-by: -
David Runge authored
Signed-off-by: -
David Runge authored
As the canonical documentation is linked to from the top-level README, we move the links to specifications there fully as well and remove it from the top-level README, as links would otherwise not match. Signed-off-by: -
David Runge authored
Add link to project documentation in top-level README. Adapt all links to latest Rust API documentation to new namespaced location. Signed-off-by: -
David Runge authored
Add `build-book` recipe to build the mdbook setup and assemble documentation in a dedicated output directory. Add `serve-book` recipe to serve the book with miniserve (as we are staging the rust docs alongside we can't make use of the mdbook builtin as it would delete the rust docs). Add `watch-book` recipe to watch for changed files using watchexec and rebuild using mdbook (as we are staging the rust docs alongside we can't make use of the mdbook builtin as it would delete the rust docs). Fixes: #76 Signed-off-by:
-
David Runge authored
Assemble README and CHANGELOG files, as well as all specification files in an mdbook. Rely on symlinks to not pollute the top-level directory structure with the mdbook setup. Signed-off-by: -
David Runge authored
Call recipe once with multiple arguments instead of calling it multiple times. Signed-off-by:
-