Commit Graph

29 Commits

Author SHA1 Message Date
Wez Furlong 3c4553ad7b docs: add logo 2025-11-26 16:46:25 +00:00
Wez Furlong da19e51f38 docs: enable attr-list extension 2025-05-16 07:12:39 -07:00
Wez Furlong 3cc9728b20 docs: tags_file option is no longer needed for doc build 2025-02-05 11:24:45 -07:00
Wez Furlong 2dc9b2b319 docs: setup tags to find threadpool related options 2025-01-08 15:52:06 -07:00
Wez Furlong d7eb2dd6b2 docs: remove dead file
This toml file was from the mdbook version of the docs
2024-10-28 20:45:14 -07:00
Wez Furlong b5ca1e9d9c docs: avoid throwing error when using cached rustdoc 2024-06-12 15:21:15 -07:00
Wez Furlong af61dee616 docs: try re-enabling social card preview 2024-04-12 08:18:10 -07:00
Wez Furlong 5399a833bd Revert "docs: restore social previews"
This reverts commit 69976b5362.

It didn't seem to take and I don't care to troubleshoot this today.
2024-03-31 14:32:21 -07:00
Wez Furlong 69976b5362 docs: restore social previews
The underlying issue has now been resolved
2024-03-31 06:41:25 -07:00
Wez Furlong 4d48db612e docs: nth time's the charm 2024-03-28 15:09:49 -07:00
Wez Furlong b829a404ae ci: docs: try another way to resolve git dates issue 2024-02-09 13:48:48 -07:00
Wez Furlong ffbec70b3e ci: disable env magic 2024-02-09 13:36:23 -07:00
Wez Furlong ae21a7f15a ci: more yaml ick? 2024-02-09 13:33:05 -07:00
Wez Furlong 26d04f33bc docs: WARNINGS -> error 2024-02-08 08:24:30 -07:00
Wez Furlong f65e985e64 docs: add since macro. document connection metadata object 2023-06-28 13:52:15 -07:00
Wez Furlong 09dcd59473 move minimal init.lua to assets dir, include that in docs 2023-04-13 09:44:07 -07:00
Wez Furlong a4c9a59b27 docs: analytics 2023-04-06 12:51:32 -07:00
Wez Furlong 487c1e25ef docs: fixup changelog
Give the `main` page a non-empty title in the TOC.
The intent is that we'll roll that page over to a release specific
page when we cut a release and then empty out `main` again.

Enable the magiclink extension for mkdocs, so that GH issue number
links work without any additional ceremony.
2023-04-05 09:05:19 -07:00
Wez Furlong 36aa20de89 docs: show repo name in GH link in top right corner 2023-03-31 12:20:49 -07:00
Wez Furlong 8f320babeb update for org rename 2023-03-28 16:47:50 -07:00
Wez Furlong a3d4c49ef1 docs: avoid copying $ prefixes from console code blocks
Rather than using `bash` for the mix of shell and output,
use `console`. That will cause the text to be marked up so
that the `$` prompt stuff won't get selected by dragging.

Enable copy button to copy the whole block, and add some
js to filter out the the $ and # prefixes from that content.
2023-03-14 10:17:55 -07:00
Wez Furlong 6b9b01eca0 disable social media cards in local builds
Enable it for the final deploy
2023-03-13 15:38:18 -07: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
Wez Furlong c41b8fa693 docs: make a pass over environment considerations 2023-03-13 06:33:56 -07:00
Wez Furlong d14b39d86f docs: add centos7 rpm install to getting started
This uses the content tabs feature to group instructions by OS
2023-03-13 06:07:04 -07:00
Wez Furlong 43dda4576e docs: add copyright and GH link to footer 2023-03-11 23:41:28 -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 8a1bf0b7a3 docs: cleanup toc structure a bit
Remove a redundant parent node to simplify things.
A couple of Page entries were just containers and
had no content of their own; you can now set the filename
to None to indicate that, and adjust what gets emitted
in the nav.
2023-03-11 20:52:21 -07:00
Wez Furlong f0c893582e switch from mdbook to mkdocs 2023-03-11 20:13:54 -07:00