Skip to content

docs: cleaner SoC in readme's #469

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jdm merged 3 commits into from
Aug 29, 2026
+23 −16
Merged

docs: cleaner SoC in readme's #469

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
dcce281
docs: adde warning to crate readme, trimmed github readme and linked …
alejandro-vaz Aug 28, 2026
88305bb
docs: added explicit message to visit wiki to contributors
alejandro-vaz Aug 29, 2026
bd439ad
Update .github/README.md
alejandro-vaz Aug 29, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 3 additions & 8 deletions .github/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,10 @@
# Contributing to rust-smallvec

This branch contains the code for SmallVec v2, which is not yet ready for release.
If your code is using any of the alpha versions of SmallVec, be aware that the API
might change between versions.
This branch contains the code for SmallVec v2, which is on pre-release.

The status of v2 can be tracked in:

- [the milestones](https://github.com/servo/rust-smallvec/milestones)
- [the wiki spec](https://github.com/servo/rust-smallvec/wiki)
Visit [the wiki](https://github.com/servo/rust-smallvec/wiki) for more information about the status and management of v2. Visit it before making any contribution.

The source code for the latest smallvec 1.x.y release can be found on the
[v1 branch](https://github.com/servo/rust-smallvec/tree/v1). Bug fixes for
smallvec v1 should be based on that branch, while new feature development should
go on the v2 branch.
go on the v2 branch.
28 changes: 20 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,23 @@
rust-smallvec
=============

## About smallvec

[Documentation](https://docs.rs/smallvec/)

[Wiki](https://github.com/servo/rust-smallvec/wiki)
# rust-smallvec

> [!WARNING]
> smallvec v2 is on pre-release
>
> this means that there might be unexpected changes between versions. see the changelog
> for detailed breakdowns
>
> changes include, but are not limited to:
> - breaking API changes
> - deprecation of items
> - adding, removing or modifying features
>
> beware that this is a pre-release and we can't ensure that there are no vulnerabilities
> or corner cases. if this feels like a substantial risk to you, please downgrade to the
> latest v1 version
>
> we are looking for people to test this v2 version, so feel free to play around with
> smallvec and use it for your purposes if this warning is not a concern, and please file
> an issue on the repo if you find some unexpected behavior or have a request for a feature

[Release notes](https://github.com/servo/rust-smallvec/releases)

Expand Down
Loading