From 37ac598b0185aa594380606351ee59287b1c0112 Mon Sep 17 00:00:00 2001 From: ANISAYAK MITRA <266799942+anisayakmitra-in@users.noreply.github.com> Date: Fri, 28 Aug 2026 11:26:00 +0530 Subject: [PATCH 1/2] docs: separate repository README Signed-off-by: ANISAYAK MITRA <266799942+anisayakmitra-in@users.noreply.github.com> --- .github/README.md | 18 ++++++++++++++++++ README.md | 14 -------------- 2 files changed, 18 insertions(+), 14 deletions(-) create mode 100644 .github/README.md diff --git a/.github/README.md b/.github/README.md new file mode 100644 index 0000000..9c0a92c --- /dev/null +++ b/.github/README.md @@ -0,0 +1,18 @@ +# Contributing to rust-smallvec + +> [!IMPORTANT] +> 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. +> +> 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) +> +> 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. + +For user-facing crate documentation, see the root [README](../README.md) and +[docs.rs](https://docs.rs/smallvec/). diff --git a/README.md b/README.md index 50ab222..95c9578 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,6 @@ rust-smallvec ============= -> [!IMPORTANT] -> This branch contains the code for SmallVec v2, which is not yet ready for release. -> If your code is using any of the alpha version of SmallVec, beware that the API might -> change between versions. -> -> 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) -> -> 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. - ## About smallvec [Documentation](https://docs.rs/smallvec/) From 8e5f252b50312c84ca94ccc601d5f1b32074c885 Mon Sep 17 00:00:00 2001 From: ANISAYAK MITRA <266799942+anisayakmitra-in@users.noreply.github.com> Date: Fri, 28 Aug 2026 11:37:37 +0530 Subject: [PATCH 2/2] docs: simplify repository README Signed-off-by: ANISAYAK MITRA <266799942+anisayakmitra-in@users.noreply.github.com> --- .github/README.md | 27 ++++++++++++--------------- 1 file changed, 12 insertions(+), 15 deletions(-) diff --git a/.github/README.md b/.github/README.md index 9c0a92c..3d5c5a5 100644 --- a/.github/README.md +++ b/.github/README.md @@ -1,18 +1,15 @@ # Contributing to rust-smallvec -> [!IMPORTANT] -> 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. -> -> 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) -> -> 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. +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. -For user-facing crate documentation, see the root [README](../README.md) and -[docs.rs](https://docs.rs/smallvec/). +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) + +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.