Repository navigation
docs: a README in the website's words that sends readers to the site - #25
Merged
Merged
Conversation
The README opens like the website, with the same headline, an animated preview of How it works and a link into each part of the site, and keeps only the install, one command, the one-minute example, the four files and the policies. check_site.py now checks its links into the repository and the website, the options of its commands, and that its Try-it block and counts are the website's, and the documentation workflow runs when the README or its pictures change.
The README carries the authors block the lab's other tools use, Paula Ruiz-Rodriguez and Mireia Coscolla of I2SysBio, and the all-contributors table with both of them. The citation reads Ruiz-Rodriguez P, Coscolla M. in the README, on every page of the website and in the BibTeX, Cargo.toml lists both authors, and check_site.py fails if a page cites differently from the README.
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
The README now reads like the website and sends people there:
assets/how-it-works.gif, 156 KB, the seven steps captured from the page), linking to the interactive version;The website link is the GitHub Pages address, which starts working once the repository is public and Pages serves
main/docs. Until then the README says how to opendocs/index.htmlfrom a clone.Authors and contributors
Cargo.tomllists both authors, as get_MNV, eskaks and snpick do.Checks
tools/check_site.pynow also checks the README: every link into the repository exists, every link into the website lands on a real page and anchor, every option in itsrecorecommands exists inrecore --help, its Try-it block and promised counts are the website's (the website's block is the one CI runs), and every page of the website cites Recore the way the README does. It was broken on purpose ten ways and caught all ten. The documentation workflow now also runs whenREADME.mdorassets/change.Locally fmt, clippy, the tests, the build,
check_site.py --run-tutorialand the auto-merge gate check all pass. I checked the rendering with GitHub's own markdown API in light and dark.