Skip to content

docs: add reporters guide and node API#774

Merged
9aoy merged 4 commits intomainfrom
docs/reporter
Dec 17, 2025
Merged

docs: add reporters guide and node API#774
9aoy merged 4 commits intomainfrom
docs/reporter

Conversation

@9aoy
Copy link
Collaborator

@9aoy 9aoy commented Dec 16, 2025

Summary

Add reporters guide and node API document.

Related Links

Checklist

  • Tests updated (or not required).
  • Documentation updated (or not required).

Copilot AI review requested due to automatic review settings December 16, 2025 11:51
@netlify
Copy link

netlify bot commented Dec 16, 2025

Deploy Preview for rstest-dev ready!

Name Link
🔨 Latest commit 0325705
🔍 Latest deploy log https://app.netlify.com/projects/rstest-dev/deploys/69422d0a3a27f60008d6cd9c
😎 Deploy Preview https://deploy-preview-774--rstest-dev.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR adds comprehensive documentation for the reporters feature in Rstest, including both user guides and API references in English and Chinese. The documentation covers built-in reporters (default, verbose, GitHub Actions, and JUnit) and provides guidance for creating custom reporters.

Key Changes

  • Added reporters guide documentation explaining usage and built-in reporters
  • Refactored configuration documentation to focus on usage patterns rather than implementation details
  • Added Node API documentation for custom reporter implementation

Reviewed changes

Copilot reviewed 12 out of 12 changed files in this pull request and generated 15 comments.

Show a summary per file
File Description
website/docs/zh/guide/basic/reporters.mdx Chinese guide for reporters with usage examples and built-in reporter descriptions
website/docs/zh/guide/basic/_meta.json Added reporters to the Chinese basic guide navigation
website/docs/zh/config/test/reporters.mdx Chinese configuration reference refactored to show usage patterns
website/docs/zh/api/node-api/reporter.mdx Chinese API documentation for custom reporter interface
website/docs/zh/api/node-api/_meta.json Added reporter to Chinese Node API navigation
website/docs/zh/api/_meta.json Added Node API section header to Chinese API navigation
website/docs/en/guide/basic/reporters.mdx English guide for reporters with usage examples and built-in reporter descriptions
website/docs/en/guide/basic/_meta.json Added reporters to the English basic guide navigation
website/docs/en/config/test/reporters.mdx English configuration reference refactored to show usage patterns
website/docs/en/api/node-api/reporter.mdx English API documentation for custom reporter interface
website/docs/en/api/node-api/_meta.json Added reporter to English Node API navigation
website/docs/en/api/_meta.json Added Node API section header to English API navigation

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

```
</Tab>

````
Copy link

Copilot AI Dec 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing closing backticks for code block. The code block starting at line 65 should end with three backticks (```), but line 72 shows four backticks (````). This will cause incorrect markdown rendering.

Copilot uses AI. Check for mistakes.
9aoy and others added 3 commits December 17, 2025 11:01
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@9aoy 9aoy merged commit b30adaf into main Dec 17, 2025
16 checks passed
@9aoy 9aoy deleted the docs/reporter branch December 17, 2025 04:13
@9aoy 9aoy mentioned this pull request Dec 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant