Commit Graph
4 Commits
Author SHA1 Message Date
Wez Furlong 3a1b1053bd docs: add link checking
Ideally there would be a good mkdocs based checker, but the
one that is out there only validate absolute URLs, which makes
it unsuitable for checking local relative links in the docs.

Adjust the doc build so that we also generate the SUMMARY.md
for mdbook, and use mdbook's link checker to check the links.

Fixup the couple of broken links that it found.
2023-03-13 12:01:07 -07:00
Wez Furlong ade3ae5bac docs: remove some mdbook related files that are now unused 2023-03-11 20:37:40 -07:00
Wez Furlong a0c0107a54 docs: install mdbook-admonish
See: https://tommilligan.github.io/mdbook-admonish/overview.html
https://tommilligan.github.io/mdbook-admonish/reference.html
2023-02-25 15:08:54 -07:00
Wez Furlong 831bfe9aab docs: skeleton for building the docs
Rather than edit SUMMARY.md, you edit docs/generate-toc.py
and it will flesh out sections based on the list of files
in a directory.
2023-02-25 10:50:58 -07:00