Repository navigation
docs: make the README a front page; add a sealed-memory section - #269
Merged
Merged
Conversation
Slurp9187
force-pushed
the
readme-trim
branch
4 times, most recently
from
October 21, 2026 02:08
2b142dd to
f3cf0a1
Compare
539 lines to 271. Keeps the quick start, a "which type?" table, access, naming, encoding, installation and features, and adds a Sealed memory section with a worked example (gated on the feature, so it runs in the --all-features doctest pass). Reference material moves to where it already lives and is linked: the zero-size caveats to Fixed's rustdoc, the generic macro arms to fixed_newtype!, the threat model and audit surfaces to SECURITY.md, per-release changes to the CHANGELOG. Every remaining example still runs as a doctest. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Jd6eJgv7urGn4rvMcVASo2
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Jd6eJgv7urGn4rvMcVASo2
Slurp9187
force-pushed
the
readme-trim
branch
from
October 21, 2026 02:14
f3cf0a1 to
bbb0d86
Compare
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.
Stacked on #268 (base
guarded-prekey): it needs #268's rc.15 CHANGELOG section and edits the README that #268 also touches. Once #268 merges, I'll retarget this tomain.The README goes from 539 lines to 271. It keeps:
It adds a Sealed memory section with a worked example. The README has had nothing on
sealedbeyond one table row since rc.13.The reference material it carried moves to where it already lives, and is linked from the README:
Fixedrustdoc,# Zero-sizegenericmacro armsfixed_newtype!/dynamic_newtype!rustdocEvery remaining example still runs as a doctest. The sealed one is gated on its feature, so it runs in the
--all-featurespass, and thefull-only pass skips it. Both passes are green locally: 131 doctests with every feature (117 that run and 14compile_fail) and 110 withfull(107 and 3). All six README examples run in both; the sealed one's body runs only with every feature on.🤖 Generated with Claude Code
https://claude.ai/code/session_01Jd6eJgv7urGn4rvMcVASo2