docs: cut the README down to an entry point and send readers to the site - #5
Merged
Conversation
The README had grown into a second copy of the documentation: input formats, algorithm descriptions, per-command options, benchmark tables and the source tree, all duplicated from pages that say the same thing better and stay in sync. The site was reachable only from one word in a nav line, so nobody followed it. It is now 173 lines instead of 351, opens with a documentation call to action under the tagline, and links to the relevant page from every section rather than restating it. Two things lived only in the README and moved rather than disappearing: the feature comparison against fastlin, TB-Profiler, Mykrobe, SNP-IT and KvarQ now sits in Benchmarks next to the measured timings, and the source tree sits in the algorithms overview, where each entry has a page describing it. The tree was also wrong: it listed a match/index.rs that does not exist and omitted lib.rs and defaults.rs.
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.
The README had grown into a second copy of the documentation: input formats, algorithm descriptions, per-command options, benchmark tables and the source tree, all duplicated from pages that say the same thing better and stay in sync. The site was reachable only from one word in a nav line, so nobody followed it.
What changed
351 lines to 173. It now opens with a documentation call to action directly under the tagline, and every section links to the relevant page instead of restating it.
Removed because the site covers it: the full installation tables, the input-format examples, the per-command options, the algorithm index, the GUI build instructions and the performance detail.
Moved, not deleted
Two things lived only in the README:
While moving it, the tree turned out to be wrong: it listed a
match/index.rsthat does not exist, and omittedlib.rsanddefaults.rs. Corrected against the actual layout.Checks
All 16 documentation links resolve against the published site, the deep anchors included.
mkdocs build --strictis clean. The result was rendered through GitHub's own markdown API to confirm it looks right.