diff --git a/CHANGELOG.md b/CHANGELOG.md index 370bcf5..9131d8e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -114,13 +114,15 @@ and Recore uses semantic versioning. policy, and the drawings decide by the same rules as the code, which `tools/check_site.py` holds them to. The README follows the website: the same opening, the same numbered steps, an animated preview of How it works - and a link into each part of the site. `tools/check_site.py` checks its - links, the options of its commands, and that its Try-it block and counts - are the website's. The README names the authors, Paula Ruiz-Rodriguez and - Mireia Coscolla, and the contributors; the citation reads "Ruiz-Rodriguez P, - Coscolla M." in the README, on the website and in its BibTeX, and - `Cargo.toml` lists both authors. `tools/check_site.py` fails if a page of the - website cites differently from the README. + in the reader's light or dark theme, and a link into each part of the site. + `tools/check_site.py` checks its links, the options of its commands, that + its Try-it block and counts are the website's, and that no picture which + follows the theme sits inside a link, where GitHub breaks it. The README + names the authors, Paula Ruiz-Rodriguez and Mireia Coscolla, and the + contributors; the citation reads "Ruiz-Rodriguez P, Coscolla M." in the + README, on the website and in its BibTeX, and `Cargo.toml` lists both + authors. `tools/check_site.py` fails if a page of the website cites + differently from the README. - `publication_status` in `orthology_evidence.tsv` follows `matrix_action`. Evidence the matrix policy or a quality floor kept out reads `held_out_policy` or `held_out_quality` instead of a `corrected...` value, and a strict diff --git a/README.md b/README.md index b27caab..5f116e8 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,8 @@
- 
+
+
One empty cell, seven steps. The interactive version lets you pick what the search finds.
docs/index.html, docs/how-it-works.html and docs/reference.html, styled by docs/assets/site.css and driven by docs/assets/site.js: plain files, so opening docs/index.html in a browser shows a change. Keep the front page short. It is there to get someone running in two minutes; the details belong in the documentation.
The drawings of How it works are docs/assets/how.js. They decide with a copy of evidence_state and matrix_policy_corrects from src/pipeline.rs, so a change to those rules is a change there too; tools/check_site.py fails if the policy table, a state, a rescue type, a matrix action or a column no longer matches the code.
The README is the same front door on GitHub, in the website's words: keep the two in step. tools/check_site.py checks the README's links into the repository and into the website, the options of its recore commands, and that its Try-it block and counts are the website's.
A picture that follows the reader's theme, like the logo and the How it works preview, is a bare <picture> with a _dark source: put inside a link, GitHub moves the image out of it and the image stops following the theme. The check fails on that too.
The Docs tab is these markdown pages. tools/build_docs.py turns each one into an .html page next to it, with the site's header, sidebar, contents and search, and writes docs/documentation.html and the search index. The pages are committed, so after editing a .md file, rebuild them:
python3 tools/build_docs.py
A new page is a line in PAGES at the top of that script.