docs: separate repository README - #465
Merged
alejandro-vaz merged 2 commits intoAug 28, 2026
Merged
alejandro-vaz merged 2 commits into
alejandro-vaz merged 2 commits into
Conversation
Signed-off-by: ANISAYAK MITRA <266799942+anisayakmitra-in@users.noreply.github.com>
alejandro-vaz
requested changes
Aug 28, 2026
Comment on lines
+3
to
+15
| > [!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. |
Collaborator
There was a problem hiding this comment.
remove the quote block, leave it bare
Comment on lines
+17
to
+18
| For user-facing crate documentation, see the root [README](../README.md) and | ||
| [docs.rs](https://docs.rs/smallvec/). |
Collaborator
There was a problem hiding this comment.
this can be directly removed without notice
Signed-off-by: ANISAYAK MITRA <266799942+anisayakmitra-in@users.noreply.github.com>
Contributor
Author
|
Updated the repository README as requested: removed the quote-block formatting and the extra user-facing documentation pointer, leaving only the moved v2 development notice. Validation: cargo test and cargo doc --no-deps both pass. |
alejandro-vaz
approved these changes
Aug 28, 2026
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.
Summary
Closes #463.
Testing
Note: cargo test --all-features requires a nightly compiler because the optional specialization feature is nightly-only.