docs: clarify README version guidance and simplify headings#89
Merged
chenjiahan merged 2 commits intomainfrom Apr 2, 2026
Merged
docs: clarify README version guidance and simplify headings#89chenjiahan merged 2 commits intomainfrom
chenjiahan merged 2 commits intomainfrom
Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates the project README to better guide users to version-appropriate documentation and to make the API documentation headings easier to scan.
Changes:
- Updates the license badge link to point at the current repository.
- Adds an installation note directing Rspack v1 users to the
v1.xbranch README. - Simplifies nested API doc headings by removing repeated
RspackChainprefixes.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
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
v1.xbranch READMERspackChainprefixes in nested README headings to make the API docs easier to scanRelated Links