docs: add logging guide#7371
Conversation
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request significantly enhances the Rsbuild documentation by introducing a dedicated and comprehensive guide on logging. This guide centralizes all information related to Rsbuild's logging mechanisms, including log levels, custom loggers, and accessing logger instances. By consolidating this information, the PR improves clarity and navigability for users seeking to understand and configure logging behavior, while also simplifying existing API and configuration reference pages. Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here. Footnotes
|
Deploying rsbuild with
|
| Latest commit: |
b4c1504
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://a1cc517f.rsbuild-v2.pages.dev |
| Branch Preview URL: | https://codex-docs-logging-guide.rsbuild-v2.pages.dev |
There was a problem hiding this comment.
Code Review
This pull request does a great job of centralizing logging documentation into a dedicated guide for both English and Chinese versions. The refactoring of existing pages to link to this new guide is clean and improves the overall structure. I've found a few minor issues in the code examples within the new Chinese documentation file that should be addressed to prevent user confusion.
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 6c60b88999
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
There was a problem hiding this comment.
Pull request overview
This PR introduces a dedicated “Logging” guide (EN/ZH) and refactors existing API/config/plugin docs to link to that guide instead of duplicating logger explanations.
Changes:
- Add new advanced “Logging” guides in English and Chinese.
- Update logger-related entries across API/plugin/config docs to link to the new guide.
- Add the new logging pages to the advanced guide navigation metadata.
Reviewed changes
Copilot reviewed 14 out of 14 changed files in this pull request and generated 7 comments.
Show a summary per file
| File | Description |
|---|---|
| website/docs/en/guide/advanced/logging.mdx | Adds new English logging guide covering log levels, custom logger, and access patterns. |
| website/docs/zh/guide/advanced/logging.mdx | Adds new Chinese logging guide covering log levels, custom logger, and access patterns. |
| website/docs/en/guide/advanced/_meta.json | Adds logging to EN advanced guide nav. |
| website/docs/zh/guide/advanced/_meta.json | Adds logging to ZH advanced guide nav. |
| website/docs/en/plugins/dev/core.mdx | Replaces inline api.logger explanation with a link to the logging guide. |
| website/docs/zh/plugins/dev/core.mdx | Replaces inline api.logger explanation with a link to the logging guide. |
| website/docs/en/api/javascript-api/core.mdx | Simplifies createLogger / logger docs and links to the logging guide. |
| website/docs/zh/api/javascript-api/core.mdx | Simplifies createLogger / logger docs and links to the logging guide. |
| website/docs/en/api/javascript-api/instance.mdx | Replaces inline rsbuild.logger explanation with a link to the logging guide. |
| website/docs/zh/api/javascript-api/instance.mdx | Replaces inline rsbuild.logger explanation with a link to the logging guide. |
| website/docs/en/config/log-level.mdx | Updates logLevel description to emphasize “current instance” semantics. |
| website/docs/zh/config/log-level.mdx | Updates logLevel description to emphasize “current instance” semantics. |
| website/docs/en/config/custom-logger.mdx | Links customLogger docs to the logging guide; removes duplicated explanation. |
| website/docs/zh/config/custom-logger.mdx | Links customLogger docs to the logging guide; removes duplicated explanation. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Summary
This PR adds a dedicated logging guide.
It also moves logger-related explanations out of the API and config reference pages, and updates those entries to link back to the new guide.
Related Links
None