Repository navigation
Give each crate a README of its own, compiled with the doctests - #283
Merged
Merged
Conversation
Every crate showed the workspace README on crates.io, the front door's story told six more times. Each guard crate, the reader and core now carry a README that says what it reads, how to depend on it (through `milo-guards` and its feature, or on its own), its example and the contract, with absolute links so crates.io resolves them. The example is included in the crate's doctests like the front door's, so it cannot drift from the code. `milo-guards` keeps the workspace README, which is about it. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
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.
Every crate showed the workspace README on crates.io. Each guard crate, the reader and core now carry a README of their own: what it reads, how to depend on it (through
milo-guardsand its feature, or on its own), its example and the contract, with absolute links so crates.io resolves them. Each README's example is included in that crate's doctests the way the front door's already is, so it cannot drift from the code.milo-guardskeeps the workspace README, which is about it. The changelog's Unreleased section names this and the logo fix (#282).just verifypasses (coverage 96.4%) andjust packagebuilds all seven crates, each archive with its own README. The pages on crates.io change with the next publish.🤖 Generated with Claude Code