Repository navigation
docs: correct drift against the tree and rewrite for readability - #1714
Merged
Merged
Conversation
Two passes over every durable Markdown doc (root and crate READMEs,
STABILITY, RELEASING, CONTRIBUTING, SECURITY, docs/, and the book
source), each reviewed by an independent fresh-context agent.
Accuracy. Roughly 165 claims no longer matched the code. Among them:
`find` / `count` take node types through `-t/--type`, not
positionally, and the CLI README was missing `vcs`, `init`, `diff`,
`diff-baseline` and `exemptions`; `-t 0` does not match `ERROR`
(that is `65535`); check baselines never filter report hotspot
tables; the documented `cargo mutants` alias is unresolvable under
current cargo; the Python pages gave the detection precedence as
extension, shebang, mode line (it is extension, mode line, shebang);
`partial_risk_score` is not "always lower" than a commit score; the
cognitive rule charged `try` where only `catch` pays; RELEASING
still described the repository as pre-public with the publish
variables unset and named two jobs that do not exist; STABILITY
listed a `Metrics` type removed at 2.0 and the pre-2.0 `Span` keys.
Hardcoded test and corpus counts become approximate language or a
presence matrix, per docs/conventions/documentation.md. Historical
records (threshold_corpus.md, the output-normalization postmortem,
measured figures in benchmarking.md and fuzzing.md) keep every
number, date and revision.
Readability. Under docs/conventions/documentation.md: prose em
dashes removed (quoted CLI output and marker syntax keep theirs),
first-mention links added for external tools and standards,
orientation openings added where a page started cold, and
`check.md`, `RELEASING.md`, `benchmarking.md` and `fuzzing.md`
reordered so the common question comes first. Every renamed heading
keeps its old slug through an explicit `{#id}`; the `## ` headings
`doc_anchors_resolve_to_book_headings` pins, the threshold tables
`doc_summary_tables_match_the_default_table` pins, the
`{{#include}}` ranges, and the version pins `check-versions` gates
are unchanged. The convention now names the em-dash replacements.
STABILITY.md's Process section now acknowledges both non-MSRV
`(breaking)` entries in the 2.x line (#1056, #1238). The unused
FreeBSD packaging templates go with the job #346 removed. README.md's
relative links still resolve only on GitHub; left as is.
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.
Summary
Two passes over every durable Markdown doc (root and crate READMEs,
STABILITY.md,RELEASING.md,CONTRIBUTING.md,SECURITY.md,docs/, and the book source), each reviewed by an independent fresh-context agent. One commit; 76 files.Accuracy
Roughly 165 claims no longer matched the code. Each fix is recorded with its evidence (oracle file:line or command output) in the sweep's findings; the ones that change what a reader would do:
find/counttake node types through-t/--type, not positionally; the CLI README was missingvcs,init,diff,diff-baselineandexemptions.-t 0does not matchERROR(that is65535); check baselines never filter report hotspot tables; the cognitive rule chargedtrywhere onlycatchpays; CC was presented as the minimum branch-coverage test count.cargo mutantsalias is unresolvable under cargo 1.99 (fix(tooling): thecargo mutantsalias in .cargo/config.toml is unresolvable under cargo 1.99 #1710); the doc now callscargo-mutantsdirectly.InvalidDiffErrorwas attributed tovcs.commit; the "zip works" example did not.partial_risk_scoreis not "always lower" than a commit score (jit.rssays the opposite); the REST route list omittedHEAD;/metricsomittednpm/npa.RELEASING.mdstill described the repository as pre-public with the publish variables unset, named two jobs that do not exist, and a[workspace.dependencies]pin that does not.STABILITY.mdlisted aMetricstype removed at 2.0 and the pre-2.0Spankeys. It now also names both non-MSRV(breaking)entries in the 2.x line (fix(wire): recursive Serialize/Drop on FuncSpace lack the #700 de-recursion #1056, fix(py): batch docs promise 1:1 results under skip_generated=False, but tiny/binary files still drop slots #1238).docs/conventions/documentation.md. Historical records (threshold_corpus.md, the output-normalization postmortem, measured figures inbenchmarking.mdandfuzzing.md) keep every number, date and revision.Readability
Under
docs/conventions/documentation.md: prose em dashes removed (quoted CLI output and marker syntax keep theirs), first-mention links for external tools and standards, orientation openings where a page started cold, andcheck.md,RELEASING.md,benchmarking.mdandfuzzing.mdreordered so the common question comes first. The convention now names the em-dash replacements.Pinned names
Every renamed heading keeps its old slug through an explicit
{#id}. Unchanged: the##headingsdoc_anchors_resolve_to_book_headingspins, the threshold tablesdoc_summary_tables_match_the_default_tablepins, every{{#include}}range, and the version pinscheck-versionsgates. A before/after audit of every fragment link in the tree is identical.Also
README.ja.mdmirrors the factual corrections and new links; heading order was unchanged.README.md's relative links still resolve only on GitHub (crates.io, the deb/rpm and the tarball ship it too); left as is.cargo mutantsalias in .cargo/config.toml is unresolvable under cargo 1.99 #1710, chore(tooling): stale literals in worktree-setup, grammar scripts and workflow comments #1711, chore: stale doc comments name removed items and pre-2.0 behaviour #1712, docs(skills): add-lang skill is behind the live mk_langs! shape, metric count and role tables #1713.Verification
make pre-commit:BCA_GATE: pass (gate=pre-commit).rumdl checkclean on all 80 tracked Markdown files;make bookbuilds;make check-versionspasses;default_thresholds(9) anddoc_anchors(1) tests pass.