Skip to content

docs(react): add performance profiling documentation#770

Merged
Yradex merged 1 commit intolynx-family:mainfrom
hzy:p/hzy/docs-react-profiling
Feb 2, 2026
Merged

docs(react): add performance profiling documentation#770
Yradex merged 1 commit intolynx-family:mainfrom
hzy:p/hzy/docs-react-profiling

Conversation

@hzy
Copy link
Copy Markdown
Contributor

@hzy hzy commented Feb 2, 2026

Summary

Add documentation for ReactLynx's production profiling feature introduced in lynx-stack#1336.

This documentation covers:

  • Overview of available trace events (ReactLynx::render, ReactLynx::diff, ReactLynx::diffFinishNoPatch, ReactLynx::commit, ReactLynx::patch, ReactLynx::setState)
  • How to enable profiling (with link to trace recording guide)
  • Understanding trace events and their meanings
  • Flow ID tracking for tracing complete update flows
  • Tips for improving component name readability in production builds (including displayName and tree-shaking workarounds)
  • Best practices for performance profiling

Checklist

  • Documentation updated
  • Tests updated (not required)
  • Changeset added (not required)

Change-Id: Id18fee5865f2e01f3154921e26304a95506daa5f
Copilot AI review requested due to automatic review settings February 2, 2026 08:57
@netlify
Copy link
Copy Markdown

netlify Bot commented Feb 2, 2026

Deploy Preview for lynx-doc ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 6e1e208
🔍 Latest deploy log https://app.netlify.com/projects/lynx-doc/deploys/698066de892dd600084f2c20
😎 Deploy Preview https://deploy-preview-770--lynx-doc.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
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

This PR adds comprehensive documentation for ReactLynx's production profiling feature, enabling developers to analyze and optimize component performance in production builds.

Changes:

  • Adds detailed profiling documentation covering trace events, enabling profiling, understanding events, flow ID tracking, and best practices
  • Creates a new "Performance" section in the React documentation navigation
  • Provides documentation in both English and Chinese with consistent content

Reviewed changes

Copilot reviewed 6 out of 7 changed files in this pull request and generated no comments.

Show a summary per file
File Description
docs/en/react/performance/profiling.mdx English documentation for ReactLynx profiling feature with comprehensive coverage of trace events, setup, and optimization techniques
docs/zh/react/performance/profiling.mdx Chinese translation of profiling documentation maintaining consistency with English version
docs/en/react/performance/_meta.json Metadata configuration for English performance section
docs/zh/react/performance/_meta.json Metadata configuration for Chinese performance section
docs/en/react/_meta.json Updated English React documentation navigation to include Performance section
docs/zh/react/_meta.json Updated Chinese React documentation navigation to include Performance section

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

@Yradex Yradex merged commit db80267 into lynx-family:main Feb 2, 2026
10 of 11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants