Repository navigation
docs: build the site with MkDocs Material and publish to GitHub Pages - #238
Merged
Merged
Conversation
outofcoffee
force-pushed
the
proper-docs-site
branch
from
September 19, 2026 19:07
2d17f52 to
d38b8ed
Compare
outofcoffee
marked this pull request as ready for review
September 19, 2026 20:55
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Build the user documentation as a proper site with MkDocs Material, themed in the spinloop brand, and publish it to GitHub Pages at
docs.spinloop.ai.Summary
docs/with MkDocs Material 9.7.7 (pinned), themed from the brand tokens: near-black ground, the mint accent, Poppins for headings, IBM Plex for body and code (mkdocs.yml,docs/stylesheets/main.css,overrides/main.html)docs/guides/(local serving, opening the agent, Hugging Face, daemon nodes, cloud deployment, fleets, the gateway, working a backlog), a command reference with an index page, and the missing page types — troubleshooting, FAQ, and a link to the repositorydocs/maintainer/so the site is user-facing by defaultmkdocs build --strict, so a dead page fails the build), a deploy job onmainthat writes theCNAMEfordocs.spinloop.aiscripts/docs-serve.shserves the site locally in Docker, building the same pinned version CI usesImplementation details
primaryandaccentare set tocustom, and the brand values are applied indocs/stylesheets/main.cssunder[data-md-color-scheme=slate], the selector Material's own palette rules target, so the overrides win the cascade.extra_cssis a top-level key — a value undertheme:is accepted and silently ignored.CNAMEis written by the deploy job rather than committed underdocs/, so the domain lives with the deployment anddocs/stays pure content.maindeploy needs the repository's Pages setting pointed at thegithub-pagesenvironment (Settings → Pages → Source: GitHub Actions), anddocs.spinloop.aineeds a DNS CNAME tospinloop-ai.github.io.