Commit Graph

13 Commits

Author SHA1 Message Date
Mike Hillyer 7890f69cf7 Got rid of mis-spelled placeholder. 2023-03-13 15:51:38 -04: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 1457b7217d Cleanup of the bug reporting page. 2023-03-13 12:32:13 -04:00
Mike Hillyer b875641297 Adding configuration chapter skeleton. 2023-03-13 12:32:13 -04:00
Mike Hillyer ecd69baf42 Building out new UserGuide structure. 2023-03-13 11:34:23 -04:00
Wez Furlong dc47e50ec6 docs: tweak credits page 2023-03-13 07:45:57 -07:00
Wez Furlong 0ab9b2870e docs: revise copyright notice
Until we confirm the name of the legal entity, just use me for the
moment.
2023-03-11 23:47:15 -07:00
Wez Furlong 52d204984a docs: install exclude plugin to exlude stuff better
Previously, I was cleaning up some junk like _index directories
generated from the _index.md fragments. I noticed that those
were showing up in the search index, so it is better to exclude
from the outset. mkdocs doesn't natively support the idea of
exclusion, but there is a plugin that does, so use it.
2023-03-11 23:27:49 -07:00
Wez Furlong b56bed5060 docs: fix admonish syntax, explain the global variable thing better 2023-03-11 23:06:59 -07:00
Mike Hillyer 38e9be00b0 Fixes. 2023-03-12 00:34:19 -05:00
Mike Hillyer 3620d07026 More formatting. 2023-03-12 00:25:27 -05: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
Mike Hillyer 4b4391516d Rearranging the documentation for new Material for Mkdocs 2023-03-11 23:49:48 -05:00