Repository navigation
Rewrite the READMEs around the website documentation - #283
Merged
Merged
Conversation
The website hosts the main documentation, but the READMEs linked it once and buried it. They now open with a link row and a table that routes each reader to the page answering their question, and the crate READMEs gain badges, a title that states what each crate is, and a license section. The crate README that crates.io and docs.rs show recommended the CGP Patterns book, which teaches v0.4.0 syntax and which the website rules exclude, so it now links the website instead. Three feature claims overstated what the library guarantees: provider selection adds nothing at runtime, wiring is checked when a check or a use forces it, and the `no_std` core holds when the chosen implementations support 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.
Overview
[deepseek-v4.1-flash] The READMEs now send readers to the website for the documentation and keep the repository pages to what a reader needs to install, evaluate, and contribute. The crate README that crates.io and docs.rs show for
cgprecommended the CGP Patterns book, which teaches v0.4.0 syntax and which the website rules exclude, and three feature claims overstated what the library guarantees.Motivation
The website hosts the main documentation, but the repository READMEs linked it once and buried it. The
cgpcrate's own README, whichlib.rsincludes as the crate doc, pointed readers at a book pinned to v0.4.0 and said the flexibility "costs nothing at runtime".Impact
The claims now carry their conditions: provider selection adds nothing at runtime, wiring is checked when a check or a use forces it, and the
no_stdcore holds when the chosen implementations support it. Thecargo-cgpqualification is copied verbatim wherever the tool's diagnostic benefit appears, and the word "capability" no longer names a CGP construct.The crate READMEs gain badges, a title that states what each crate is, a website link row, and a license section. The root README gains a link row and a table that routes each reader to the page answering their question, and
sibling-projects.mdnames the knowledge base's list as the authoritative record of the ecosystem.