Skip to content

Give each crate a README of its own, compiled with the doctests - #283

Merged
camiloazula merged 1 commit into
mainfrom
docs/crate-readmes
Nov 5, 2026
Merged

camiloazula merged 1 commit into
mainfrom
docs/crate-readmes

Conversation

@camiloazula

Copy link
Copy Markdown
Owner

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-guards and 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-guards keeps the workspace README, which is about it. The changelog's Unreleased section names this and the logo fix (#282).

just verify passes (coverage 96.4%) and just package builds all seven crates, each archive with its own README. The pages on crates.io change with the next publish.

🤖 Generated with Claude Code

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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant