Source for Fleet documentation, built with MkDocs and Material for MkDocs. Pages live in content/, text that several pages include lives in snippets/, and the navigation is in mkdocs.yml.
Every page follows the Markdown style guide.
python3 -m venv .venv
.venv/bin/pip install -r requirements.txt
.venv/bin/mkdocs serveOpen http://127.0.0.1:8000/. The page reloads on save.
Before pushing, run the same checks CI does:
.venv/bin/mkdocs build --strict
npx markdownlint-cli2 "**/*.md" "#.venv" "#site"--strict fails on any broken link or anchor.
Every push to main builds the site and deploys it to GitHub Pages through .github/workflows/pages.yml. The repo's Settings > Pages > Source must be set to GitHub Actions.
- Create the page under the right section in
content/, with a kebab-case filename. - Add it to
navinmkdocs.yml. Pages missing fromnavstill build, but nobody can find them. - Put images in an
img/folder beside the page that uses them.
A page about one of the fleet's tools goes in content/tools/<tool>/. The primer is index.md, and each how-to is a file beside it. Add a new term to content/tools/glossary.md, in alphabetical order. See Tool pages for both shapes.
A diagram is a mermaid code block in the page. See Diagrams for when an SVG is used instead.
requirements.txt pins MkDocs to 1.6. MkDocs 2.0 drops the plugin and theme system this site depends on, so do not upgrade past 1.x without planning a migration.
Copyright (C) 2026 Myah Mitchell. Everything in this repo, the published pages and their code snippets included, is licensed under Creative Commons Attribution-ShareAlike 4.0 International. You can copy, adapt, and republish it, commercially too, as long as you credit Myah Mitchell with a link to https://fleet-docs.myah-mitchell.com/, say what you changed, and release your version under the same license.