Skip to content

docs: add customLogger config docs#7367

Merged
chenjiahan merged 4 commits intomainfrom
codex/docs-custom-logger
Mar 23, 2026
Merged

docs: add customLogger config docs#7367
chenjiahan merged 4 commits intomainfrom
codex/docs-custom-logger

Conversation

@chenjiahan
Copy link
Copy Markdown
Member

@chenjiahan chenjiahan commented Mar 23, 2026

Summary

  • Add customLogger config docs, including recommended createLogger() usage, global vs instance logger access, and version history.
  • Update the createLogger API docs to mention that the created logger can be passed to customLogger.

Related Links

Copilot AI review requested due to automatic review settings March 23, 2026 06:42
@gemini-code-assist
Copy link
Copy Markdown
Contributor

Summary of Changes

Hello, 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 introduces documentation for the customLogger configuration option in Rsbuild. It provides comprehensive guides in both English and Chinese, detailing its usage, benefits, and integration with the createLogger API. The changes enhance the discoverability and understanding of the customLogger feature for users.

Highlights

  • Documentation: Adds documentation for the customLogger configuration option, including usage examples and explanations of global vs. instance loggers.
  • API Reference: Updates the createLogger API documentation to indicate its compatibility with the customLogger configuration.
  • Navigation: Updates the configuration navigation and Vite migration documentation to link to the new customLogger documentation page.
Using Gemini Code Assist

The 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 /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.

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

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request adds documentation for the new customLogger configuration option. The changes include new documentation pages in English and Chinese, updates to navigation, and cross-references from other relevant documents. The implementation is solid, but I have a couple of suggestions to improve the clarity of the new documentation pages by expanding the main description of the customLogger option.

Copy link
Copy Markdown
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

Adds dedicated documentation for the customLogger config option (EN/ZH) and updates related docs/navigation so users can discover and use instance-scoped logging without mutating the shared global logger.

Changes:

  • Add new customLogger config pages in English and Chinese, including recommended createLogger() usage and global vs instance logger guidance.
  • Update createLogger API docs (EN/ZH) to mention it can be passed to customLogger.
  • Update config navigation and Vite migration docs (EN/ZH) to link to /config/custom-logger.

Reviewed changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
website/theme/rsbuildPluginOverview.ts Adds customLogger entry to the config overview navigation.
website/docs/en/guide/migration/vite.mdx Updates Vite→Rsbuild mapping table to link to the new customLogger config page.
website/docs/zh/guide/migration/vite.mdx Updates Vite→Rsbuild mapping table to link to the new customLogger config page.
website/docs/en/config/custom-logger.mdx New config doc page describing customLogger usage and logger access patterns.
website/docs/zh/config/custom-logger.mdx New config doc page describing customLogger usage and logger access patterns.
website/docs/en/config/_meta.json Adds custom-logger to config sidebar ordering.
website/docs/zh/config/_meta.json Adds custom-logger to config sidebar ordering.
website/docs/en/api/javascript-api/core.mdx Mentions createLogger() output can be used as customLogger.
website/docs/zh/api/javascript-api/core.mdx Mentions createLogger() output can be used as customLogger.

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

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings March 23, 2026 06:58
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copy link
Copy Markdown
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

Copilot reviewed 9 out of 9 changed files in this pull request and generated 1 comment.


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

This comment was marked as resolved.

@cloudflare-workers-and-pages
Copy link
Copy Markdown

Deploying rsbuild with  Cloudflare Pages  Cloudflare Pages

Latest commit: 85aa9b2
Status: ✅  Deploy successful!
Preview URL: https://3f5e5fb6.rsbuild-v2.pages.dev
Branch Preview URL: https://codex-docs-custom-logger.rsbuild-v2.pages.dev

View logs

@chenjiahan chenjiahan merged commit 45b1a3a into main Mar 23, 2026
5 checks passed
@chenjiahan chenjiahan deleted the codex/docs-custom-logger branch March 23, 2026 07:48
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.

3 participants