Repository navigation
Document every published crate - #284
Merged
Merged
Conversation
A crates.io or docs.rs visitor found an empty page for 25 of the 29 published crates, because only four included a README as their crate doc and the rest inherited one workspace description. Each crate now opens with a doc that states what it provides and links the reference page for its constructs, and each carries its own description. The docs build with warnings denied, which surfaced three broken intra-doc links in `cgp-macro-core` and `cgp-base-types`; those are fixed here too.
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] Every published crate now opens with a doc that says what it provides and links the reference page for its constructs, and each carries its own description. A crates.io or docs.rs visitor previously found an empty page for 25 of the 29 published crates.
Motivation
Only four crates included a README as their crate doc, and the other 25 inherited one workspace description, so the landing page of most crates said nothing about the crate. The website documents the constructs, but a reader who arrives from crates.io had no route from the crate to the page that explains it.
Impact
Each crate doc states the crate's role in one line and then links the particular reference page for each construct it provides, such as
HasFieldandIndexforcgp-field, or the seven error providers forcgp-error-extra. The maincgpcrate keeps the workspace description, which is the project's tag line, and the two test crates keep it because they are not published.The docs build with warnings denied, which surfaced three broken intra-doc links in
cgp-macro-coreandcgp-base-types; those are fixed here too. ThecgpREADME's note about sparse docs.rs pages now says each page describes its crate while the per-item documentation is still being filled in.