Repository navigation
docs: a Docs tab, light code boxes, and an illustrated How it works page - #24
Merged
Merged
Conversation
… light theme Every long page becomes a page of the website, with the site's header and theme, a page list, contents that follow the reading, previous and next links, a search box over all of them and an edit link to GitHub. tools/build_docs.py writes them from the markdown, which stays the source and still reads on GitHub, and tools/check_site.py now fails when a page no longer matches its markdown or any page of the site has a dead link. Code boxes are light in the light theme, and one-line commands wrap instead of running under the copy button.
… decision Seven animated drawings follow one empty cell from the matrix through the search, what the hit is, the neighbours and the matrix policy to what gets written down, and the reader picks what the search finds, whether the neighbours agree and the policy. The drawings decide with a copy of evidence_state and matrix_policy_corrects, and check_site.py now fails if the policy table, a state, a rescue type, a matrix action or a column drifts from the code. Every page gets the same header, with the new page in it.
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.
What changes
/) and an edit link to GitHub.tools/build_docs.pybuilds the pages from the markdown, which stays the source and still reads on GitHub.Checks
tools/check_site.pynow also:python3 tools/build_docs.py);src/pipeline.rs: its policy table must equalmatrix_policy_corrects, every state must be oneevidence_statewrites, everyrescue_typea formRescueTypeprints, every matrix action onematrix_actionwrites, and every column one ofORTHOLOGY_EVIDENCE_COLUMNS.Each new check was broken on purpose and failed as it should. Locally fmt, clippy, the tests, the build,
check_site.py --run-tutorialand the auto-merge gate check all pass, and every page fits at 360 and 390 px with no sideways scroll.