Conversation
The four pages under docs/ already read as a site; this gives them one. The changelog stays a root file and the build reads it there, so there is no second copy to drift. A local checkout carries private notes under docs/ that git already ignores — exclude_docs keeps a stray build from publishing them too.
The front page says what simloop is and shows one race found and replayed; the quickstart walks from pip install to a shrunk schedule, one command at a time. Every block on both pages was run before it was written down.
Pull requests build it strictly so a broken link cannot land; only main deploys.
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
1 participant
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.
mkdocs-material over the existing pages under docs/, plus a front page and a quickstart whose every code block was run before it was written down. The changelog stays a root file — a build hook hands it to the site, so there is no second copy to drift. Directories under docs/ are excluded from the build wholesale, the same promise the sdist allowlist makes. Deploys on every push to main; pull requests only build, strictly, so a broken link cannot land.