Commit Graph

10 Commits

Author SHA1 Message Date
MHillyer 61bf9b77cc Linter fixes. 2025-02-20 13:04:57 +00:00
MHillyer c4a6f22b25 Add a note to the index to let the reader know that the referene manual is the most current at any given time. 2025-02-20 10:05:09 +00:00
Mike Hillyer bd93c417de Add FAQ to docs index page. 2024-01-24 15:40:19 -05:00
Mike Hillyer 112052ee7a Fix link on docs index page. 2023-09-28 17:42:19 -04:00
drone 7b60309dab kick off a doc build 2023-09-19 12:12:10 -07:00
Wez Furlong c5acdec76a docs: a dummy change to trigger a doc deploy 2023-09-19 09:55:54 -07:00
Tom Mairs 298f9db7f2 rearrange docs to make more sense 2023-03-21 23:40:47 +00:00
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
Mike Hillyer 928e3cdf2b Updating structure, adding index pages to each section, along with updating the documentation landing page. 2023-03-12 00:12:42 -05: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