Skip to content
Snippets Groups Projects

feat: Render top-level docs using mdbook

Merged feat: Render top-level docs using mdbook
docs/mdbook into main
All threads resolved!
Merged David Runge requested to merge docs/mdbook into main
All threads resolved!
Viewing commit 627a0880
Next
Show latest version
22 files
+ 107
− 2
Compare changes
  • Side-by-side
  • Inline
Files
22
  • 627a0880
    David Runge
    feat: Render top-level docs using mdbook · 627a0880
    David Runge authored 
    Rely on mdbook to render top-level documentation in a concise manner.
Using the `build-book` just recipe the mdbook (including adhoc addition
of js requirements for nermaid graphs) is built from a preselected list
of documentation files.
Afterwards all Rust documentation is collected in a `rustdoc`
subdirectory of the shared documentation output directory.

The `watch-book` and `serve-book` just recipes enable a worklow in which
relevant files are watched and the output dir is continuously served
using an adhoc webserver.

Fixes: #124


Signed-off-by: default avatarDavid Runge <dvzrv@archlinux.org>
resources/docs/src/architecture/design.md 0 → 120000
+ 1
− 0
../../design.md
\ No newline at end of file