docs: cleaner SoC in readme's - #469
Merged
Merged
Conversation
jdm
approved these changes
Aug 29, 2026
Co-authored-by: Josh Bowman-Matthews <josh@joshmatthews.net> Signed-off-by: Alejandro Vaz <alejandro.vaz.myt@gmail.com>
alejandro-vaz
added a commit
to alejandro-vaz/rust-smallvec
that referenced
this pull request
Aug 29, 2026
* docs: adde warning to crate readme, trimmed github readme and linked to wiki * docs: added explicit message to visit wiki to contributors * Update .github/README.md Co-authored-by: Josh Bowman-Matthews <josh@joshmatthews.net> Signed-off-by: Alejandro Vaz <alejandro.vaz.myt@gmail.com> --------- Signed-off-by: Alejandro Vaz <alejandro.vaz.myt@gmail.com> Co-authored-by: Josh Bowman-Matthews <josh@joshmatthews.net>
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
2 participants
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.
this PR rewrites both READMEs to be clearer and target their respective audiences: GitHub visitors and crates.io prospective users
GitHub
the GitHub readme is simplified to point directly to the wiki, which we can modify much easier than having to make PRs and commits to change on-the-fly documentation
crates.io
the crates.io readme now contains a big and explicit warning about v2 being unstable that you can't miss, and also tells people to file issues if they find something wrong