Conversation
✅ Deploy Preview for rstest-dev 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 PR reorganizes documentation by moving the API documentation from the @rstest/adapter-rslib package README to the main Rslib integration guide. This consolidation improves discoverability and provides users with comprehensive documentation in one location.
- Adds detailed API documentation for
withRslibConfig()function and its options (cwd,configPath,libId,modifyLibConfig) to both English and Chinese integration guides - Simplifies the adapter README to focus on basic usage and link to the comprehensive guide
- Updates the structure of the integration guide with new "API", "Configuration mapping", and "Debug config" sections
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| website/docs/en/guide/integration/rslib.mdx | Adds comprehensive API documentation with examples for all adapter options |
| website/docs/zh/guide/integration/rslib.mdx | Chinese translation of the API documentation (contains minor issues) |
| packages/adapter-rslib/README.md | Removes detailed API documentation, now references the integration guide |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
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
Update rslib integration guide, moving the API documentation from adapter-rslib README to rslib guide.
Related Links
Checklist