Skip to content

docs: add ReactLynx solution guide - #1921

Merged
Timeless0911 merged 3 commits into
mainfrom
david/reactlynx-guide
Sep 14, 2026
Merged

Timeless0911 merged 3 commits into
mainfrom
david/reactlynx-guide

Conversation

@Timeless0911

@Timeless0911 Timeless0911 commented Sep 14, 2026 •

Copy link
Copy Markdown
Contributor

Motivation

The new @lynx-js/create-lynx scaffolder provides Rslib templates for ReactLynx component libraries. The Rslib documentation needs a dedicated guide that reflects this workflow and explains how to build, test, consume, and distribute ReactLynx libraries.

Related: lynx-family/lynx-stack#3864

Changes

  • Add English and Chinese ReactLynx solution guides.
  • Use @lynx-js/create-lynx for project creation, including direct Rslib template selection.
  • Document the required Rslib, TypeScript, package export, and Rstest configuration.
  • Explain how ReactLynx libraries are consumed by applications and other component libraries.
  • Document optional External Bundle generation through interactive selection or --tools external-bundle.

Copilot AI lite review requested due to automatic review settings September 14, 2026 09:15
@chatgpt-codex-connector

Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟢 Approval recommended

The remaining findings are non-blocking documentation link and anchor improvements.

Pull request overview

Adds bilingual ReactLynx solution guides covering builds, types, testing, publishing, and dependency distribution.

Changes:

  • Adds English and Chinese ReactLynx documentation.
  • Documents JSX preservation, Rstest integration, External Bundles, and package exports.
  • Adds both pages to the solution navigation menus.

Review notes: Remaining nit-level feedback requests authoritative package/API links, a source.entry link, and aligned heading anchors in the localized guide.

File summaries
File Description
website/docs/en/guide/solution/reactlynx.mdx English ReactLynx solution guide
website/docs/zh/guide/solution/reactlynx.mdx Chinese ReactLynx solution guide
website/docs/en/guide/solution/_meta.json English navigation entry
website/docs/zh/guide/solution/_meta.json Chinese navigation entry
Review details

Suppressed comments (5)

website/docs/en/guide/solution/reactlynx.mdx:197

  • Link source.entry here as well. This is the configuration readers must adjust for a dependency's actual output, and leaving “the entry” unlinked makes the glob and static-asset behavior harder to verify.
Adjust [outBase](/config/lib/out-base) and the entry to match the dependency's actual output, including the code, styles, and static assets to process:

website/docs/en/guide/solution/reactlynx.mdx:103

  • Link the peer dependencies to their canonical package or API pages. @lynx-js/react, @lynx-js/types, and @types/react are introduced here without direct references, so readers cannot verify the required versions from the guide.
    "@lynx-js/react": ">=0.100.0", // [!code ++]
    "@lynx-js/types": ">=4", // [!code ++]
    "@types/react": ">=19" // [!code ++]

website/docs/zh/guide/solution/reactlynx.mdx:197

  • Link source.entry here as well. This is the configuration readers must adjust for a dependency's actual output, and leaving “入口” unlinked makes the glob and static-asset behavior harder to verify.
[outBase](/config/lib/out-base) 和入口需按依赖的实际产物调整,包含需要处理的代码、样式和静态资源:

website/docs/zh/guide/solution/reactlynx.mdx:9

  • Keep the localized heading IDs aligned with the English page. These translated headings generate different default anchors (for example, this becomes 创建-reactlynx-项目 instead of create-a-reactlynx-project), so deep links copied from the English page or preserved during locale switching cannot resolve; add explicit English IDs to the Chinese headings.
## 创建 ReactLynx 项目

website/docs/zh/guide/solution/reactlynx.mdx:103

  • 请为这些 peer 依赖添加官方包页面或 API 文档链接。此处引入了 @lynx-js/react、@lynx-js/types 和 @types/react,但读者无法从指南中核对所需版本。
    "@lynx-js/react": ">=0.100.0", // [!code ++]
    "@lynx-js/types": ">=4", // [!code ++]
    "@types/react": ">=19" // [!code ++]
  • Files reviewed: 4/4 changed files
  • Comments generated: 2
  • Review effort level: Lite

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread website/docs/en/guide/solution/reactlynx.mdx
Comment thread website/docs/zh/guide/solution/reactlynx.mdx
@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Sep 14, 2026 •

Copy link
Copy Markdown

Deploying rslib with  Cloudflare Pages  Cloudflare Pages

Latest commit: 57527aa
Status: ✅  Deploy successful!
Preview URL: https://9ea2e52b.rslib.pages.dev
Branch Preview URL: https://david-reactlynx-guide.rslib.pages.dev

View logs

@Timeless0911
Timeless0911 merged commit b412038 into main Sep 14, 2026
12 checks passed
@Timeless0911
Timeless0911 deleted the david/reactlynx-guide branch September 14, 2026 09:55
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.

2 participants

Sponsor
SponsoredKunjungi sekarang
Promo