From dcce28186caa81f44af1a4b9b7ddc60e6cf93759 Mon Sep 17 00:00:00 2001 From: Alejandro Vaz Date: Fri, 28 Aug 2026 18:14:12 +0200 Subject: [PATCH 1/3] docs: adde warning to crate readme, trimmed github readme and linked to wiki --- .github/README.md | 11 +++-------- README.md | 28 ++++++++++++++++++++-------- 2 files changed, 23 insertions(+), 16 deletions(-) diff --git a/.github/README.md b/.github/README.md index 3d5c5a5..6116b94 100644 --- a/.github/README.md +++ b/.github/README.md @@ -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 containst 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. 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. \ No newline at end of file diff --git a/README.md b/README.md index 95c9578..9f86a0e 100644 --- a/README.md +++ b/README.md @@ -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) From 88305bbd1d2d1e42c614dfabd672df845a1780e8 Mon Sep 17 00:00:00 2001 From: Alejandro Vaz Date: Sat, 29 Aug 2026 03:34:36 +0200 Subject: [PATCH 2/3] docs: added explicit message to visit wiki to contributors --- .github/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/README.md b/.github/README.md index 6116b94..539d533 100644 --- a/.github/README.md +++ b/.github/README.md @@ -2,7 +2,7 @@ This branch containst the code for SmallVec v2, which is on pre-release. -Visit [the wiki](https://github.com/servo/rust-smallvec/wiki) for more information about the status and management of v2. +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 From bd439ad41fed0fafafcf237241ad83d07c250c02 Mon Sep 17 00:00:00 2001 From: Alejandro Vaz Date: Sat, 29 Aug 2026 13:38:54 +0200 Subject: [PATCH 3/3] Update .github/README.md Co-authored-by: Josh Bowman-Matthews Signed-off-by: Alejandro Vaz --- .github/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/README.md b/.github/README.md index 539d533..8b37db1 100644 --- a/.github/README.md +++ b/.github/README.md @@ -1,6 +1,6 @@ # Contributing to rust-smallvec -This branch containst the code for SmallVec v2, which is on pre-release. +This branch contains the code for SmallVec v2, which is on pre-release. 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.