docs: improve documentation for history api fallback#6521
Merged
chenjiahan merged 3 commits intomainfrom Nov 7, 2025
Merged
Conversation
✅ Deploy Preview for rsbuild ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
There was a problem hiding this comment.
Pull Request Overview
This pull request improves the documentation and type definitions for the History API fallback configuration by clarifying descriptions, adding helpful inline comments, and including JSDoc documentation for TypeScript type properties.
- Enhanced clarity of
indexandrewritesoption descriptions in both English and Chinese documentation - Added comprehensive JSDoc comments to
HistoryApiFallbackOptionstype properties - Included inline code comments in examples and a helpful tip about using
server.proxyfor non-fallback scenarios
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| website/docs/en/config/server/history-api-fallback.mdx | Updated English documentation with clearer descriptions for index and rewrites options, added inline code comments, and included a tip about server.proxy |
| website/docs/zh/config/server/history-api-fallback.mdx | Updated Chinese documentation with translations matching the English version improvements |
| packages/core/src/types/config.ts | Added comprehensive JSDoc comments to all properties of HistoryApiFallbackOptions type |
💡 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
1 participant
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
historyApiFallback.indexandhistoryApiFallback.rewritesoptionsChecklist