chore: expand a2ui catalog extractor guide by PupilTong · Pull Request #2531 · lynx-family/lynx-stack

PupilTong · 2026-04-27T12:58:29Z

Summary

Expand the A2UI catalog extractor README into a step-by-step English guide for external npm users only.
Add a matching Simplified Chinese readme.zh_cn.md and package-local AGENTS guidance for keeping the two docs synchronized.
Add a README-backed QuickStartCard fixture and extend tests for schema generation, full catalog wrapping, and CLI --typedoc-json output.
Add a Guide-level GenUI section that exposes the bilingual README content by generating Rspress docs pages under /guide/genui/a2ui-catalog-extractor and /zh/guide/genui/a2ui-catalog-extractor.

Validation

fnm exec --using v24.15.0 -- pnpm install --frozen-lockfile
fnm exec --using v24.15.0 -- pnpm -C packages/genui/a2ui-catalog-extractor test
fnm exec --using v24.15.0 -- pnpm dprint check -- packages/genui/a2ui-catalog-extractor/README.md packages/genui/a2ui-catalog-extractor/readme.zh_cn.md packages/genui/a2ui-catalog-extractor/AGENTS.md packages/genui/a2ui-catalog-extractor/test/extractor.test.ts packages/genui/a2ui-catalog-extractor/test/fixtures/catalog/QuickStartCard.tsx packages/genui/a2ui-catalog-extractor/test/fixtures/expected-catalog/QuickStartCard/catalog.json
fnm exec --using v24.15.0 -- pnpm eslint packages/genui/a2ui-catalog-extractor/test/extractor.test.ts packages/genui/a2ui-catalog-extractor/test/fixtures/catalog/QuickStartCard.tsx
fnm exec --using v24.15.0 -- node --input-type=module -e "const { createGenUIGuideReadmeDocs } = await import('./website/sidebars/genui.ts?guide=' + Date.now()); console.log(JSON.stringify(createGenUIGuideReadmeDocs({ repositoryRoot: process.cwd(), websiteRoot: process.cwd() + '/website' })));"
fnm exec --using v24.15.0 -- pnpm dprint check --incremental=false -- website/.gitignore website/rspress.config.ts website/sidebars/genui.ts
fnm exec --using v24.15.0 -- pnpm eslint website/rspress.config.ts website/sidebars/index.ts website/sidebars/genui.ts
fnm exec --using v24.15.0 -- pnpm -C website docs
fnm exec --using v24.15.0 -- pnpm -C website build:docs

Summary by CodeRabbit

Documentation
- Expanded README with Quick Start guide, CLI options reference, programming API examples, and troubleshooting guidance
- Added Simplified Chinese documentation for the A2UI Catalog Extractor tool
- Documentation integrated into the website with language-specific guides

changeset-bot · 2026-04-27T12:58:35Z

⚠️ No Changeset found

Latest commit: 2deb133

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

coderabbitai · 2026-04-27T12:58:37Z

📝 Walkthrough

Walkthrough

This PR adds comprehensive documentation and website integration for the a2ui-catalog-extractor package, including English and Chinese READMEs with quick start guides and API references, a documentation policy file, expanded test fixtures with a new QuickStartCard component, and a utility to synchronize and generate website sidebar entries from package READMEs.

Changes

Cohort / File(s)	Summary
Documentation Policy & English Reference `packages/genui/a2ui-catalog-extractor/AGENTS.md`, `packages/genui/a2ui-catalog-extractor/README.md`	Added documentation policy guidelines and expanded README from concise guide into comprehensive documentation including quick start, authoring guide, CLI options reference table, programmatic API with examples, and troubleshooting section.
Chinese Documentation `packages/genui/a2ui-catalog-extractor/readme.zh_cn.md`	Added complete Simplified Chinese translation of package documentation covering tool functionality, authoring constraints, CLI usage, programming API, and troubleshooting.
Test Suite & Fixtures `packages/genui/a2ui-catalog-extractor/test/extractor.test.ts`, `packages/genui/a2ui-catalog-extractor/test/fixtures/catalog/QuickStartCard.tsx`, `packages/genui/a2ui-catalog-extractor/test/fixtures/expected-catalog/QuickStartCard/catalog.json`	Expanded test suite with CLI end-to-end testing and added new `QuickStartCard` component fixture with typed props and expected JSON catalog schema output.
Website Build & Configuration `website/.gitignore`, `website/rspress.config.ts`, `website/sidebars/genui.ts`, `website/sidebars/index.ts`	Integrated GenUI documentation into website build system with a new `createGenUIGuideReadmeDocs` utility for synchronizing READMEs, generating sidebar entries, and managing localized documentation output directories.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Possibly related PRs

feat: add TypeDoc A2UI catalog extractor #2527: Modifies the same a2ui-catalog-extractor package with overlapping changes to documentation, tests, fixtures, and website integration.

Suggested reviewers

Sherry-hue
colinaaa
HuJean

Poem

🐰 A rabbit hops through docs so bright,
English words and Chinese right,
Tests and fixtures all aligned,
Quick starts guide with cards designed,
Websites now show genui's way,
Documentation saves the day! 📚

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'chore: expand a2ui catalog extractor guide' directly reflects the main change—expanding documentation and guides for the a2ui catalog extractor tool with new README versions, fixture tests, and Rspress website integration.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

codecov · 2026-04-27T13:01:51Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ All tests successful. No failed tests found.

📢 Thoughts on this report? Let us know!

codspeed-hq · 2026-04-27T13:27:01Z

Merging this PR will improve performance by 9.06%

⚠️

Different runtime environments detected

Some benchmarks with significant performance changes were compared across different runtime environments,
which may affect the accuracy of the results.

Open the report in CodSpeed to investigate

⚡ 1 improved benchmark
✅ 80 untouched benchmarks
⏩ 26 skipped benchmarks¹

Performance Changes

	Benchmark	`BASE`	`HEAD`	Efficiency
⚡	`002-hello-reactLynx-destroyBackground`	893.7 µs	819.4 µs	+9.06%

_{Comparing PupilTong:codex/a2ui-catalog-docs (2deb133) with main (b1809ef)}

26 benchmarks were skipped, so the baseline results were used instead. If they were deleted from the codebase, click here and archive them to remove them from the performance reports. ↩

relativeci · 2026-04-27T13:28:14Z

React Example

#7678 Bundle Size — 225.38KiB (0%).

2deb133(current) vs b1809ef main#7667(baseline)

Bundle metrics no changes

	Current #7678	Baseline #7667
Initial JS	`0B`	`0B`
Initial CSS	`0B`	`0B`
Cache Invalidation	`0%`	`0%`
Chunks	`0`	`0`
Assets	`4`	`4`
Modules	`179`	`179`
Duplicate Modules	`69`	`69`
Duplicate Code	`44.57%`	`44.57%`
Packages	`2`	`2`
Duplicate Packages	`0`	`0`

Bundle size by type no changes

	Current #7678	Baseline #7667
IMG	`145.76KiB`	`145.76KiB`
Other	`79.63KiB`	`79.63KiB`

Bundle analysis report Branch PupilTong:codex/a2ui-catalog-doc... Project dashboard

^{Generated by RelativeCI Documentation Report issue}

relativeci · 2026-04-27T13:28:25Z

React External

#794 Bundle Size — 680.27KiB (0%).

2deb133(current) vs b1809ef main#783(baseline)

Bundle metrics no changes

	Current #794	Baseline #783
Initial JS	`0B`	`0B`
Initial CSS	`0B`	`0B`
Cache Invalidation	`0%`	`0%`
Chunks	`0`	`0`
Assets	`3`	`3`
Modules	`17`	`17`
Duplicate Modules	`5`	`5`
Duplicate Code	`8.59%`	`8.59%`
Packages	`0`	`0`
Duplicate Packages	`0`	`0`

Bundle size by type no changes

	Current #794	Baseline #783
Other	`680.27KiB`	`680.27KiB`

Bundle analysis report Branch PupilTong:codex/a2ui-catalog-doc... Project dashboard

^{Generated by RelativeCI Documentation Report issue}

relativeci · 2026-04-27T13:28:25Z

Web Explorer

#9251 Bundle Size — 900.02KiB (0%).

2deb133(current) vs b1809ef main#9240(baseline)

Bundle metrics

2 changes

	Current #9251	Baseline #9240
Initial JS	`44.46KiB`	`44.46KiB`
Initial CSS	`2.22KiB`	`2.22KiB`
Cache Invalidation	`0%`	`0%`
Chunks	`9`	`9`
Assets	`11`	`11`
Modules	`229`(`+0.88%`)	`227`
Duplicate Modules	`11`	`11`
Duplicate Code	`27.28%`(`-0.04%`)	`27.29%`
Packages	`10`	`10`
Duplicate Packages	`0`	`0`

Bundle size by type no changes

	Current #9251	Baseline #9240
JS	`495.88KiB`	`495.88KiB`
Other	`401.92KiB`	`401.92KiB`
CSS	`2.22KiB`	`2.22KiB`

Bundle analysis report Branch PupilTong:codex/a2ui-catalog-doc... Project dashboard

^{Generated by RelativeCI Documentation Report issue}

relativeci · 2026-04-27T13:28:29Z

React MTF Example

#810 Bundle Size — 196.54KiB (0%).

2deb133(current) vs b1809ef main#799(baseline)

Bundle metrics no changes

	Current #810	Baseline #799
Initial JS	`0B`	`0B`
Initial CSS	`0B`	`0B`
Cache Invalidation	`0%`	`0%`
Chunks	`0`	`0`
Assets	`3`	`3`
Modules	`173`	`173`
Duplicate Modules	`66`	`66`
Duplicate Code	`44.08%`	`44.08%`
Packages	`2`	`2`
Duplicate Packages	`0`	`0`

Bundle size by type no changes

	Current #810	Baseline #799
IMG	`111.23KiB`	`111.23KiB`
Other	`85.31KiB`	`85.31KiB`

Bundle analysis report Branch PupilTong:codex/a2ui-catalog-doc... Project dashboard

^{Generated by RelativeCI Documentation Report issue}

coderabbitai

Actionable comments posted: 1

🧹 Nitpick comments (1)

packages/genui/a2ui-catalog-extractor/README.md (1)

35-40: Optional readability polish for repeated bullet openings.

The five consecutive bullets starting with “It does not …” are clear, but varying one or two openings would make the section read smoother.

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@packages/genui/a2ui-catalog-extractor/README.md` around lines 35 - 40, The
repeated bullets all start with the same phrase "It does not …"; update the five
list items so openings vary for readability while keeping meaning — e.g., change
some to "Doesn't render A2UI UI.", "Does not parse TypeScript source text by
hand.", "Avoids using the TypeScript compiler API directly.", "Doesn't require
JSON Schema in comments.", "Does not expand arbitrary imported type aliases or
external interfaces."; ensure the unique repeated token "It does not" is removed
or varied across items and preserve the original negated semantics and order.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@website/sidebars/genui.ts`:
- Around line 29-30: The regexes used for language switching (notably the
switchPattern variable and its sibling pattern around line 40) are too strict
and fail on CRLF or altered spacing; update both patterns to allow optional CRLF
and flexible spacing (`\r?` and `\s*` around the pipe and link parts) so they
match both LF and CRLF files and variations like "English |
[简体中文](./readme.zh_cn.md)" with extra spaces; this will ensure the replacement
code around the block that modifies lines 72–75 no longer fails and prevents the
subsequent throw around lines 77–80.

---

Nitpick comments:
In `@packages/genui/a2ui-catalog-extractor/README.md`:
- Around line 35-40: The repeated bullets all start with the same phrase "It
does not …"; update the five list items so openings vary for readability while
keeping meaning — e.g., change some to "Doesn't render A2UI UI.", "Does not
parse TypeScript source text by hand.", "Avoids using the TypeScript compiler
API directly.", "Doesn't require JSON Schema in comments.", "Does not expand
arbitrary imported type aliases or external interfaces."; ensure the unique
repeated token "It does not" is removed or varied across items and preserve the
original negated semantics and order.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

Push a commit to this branch (recommended)
Create a new PR with the fixes

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: ab1cd7fd-2fff-4d88-a94a-b8ca6afcf9a4

📥 Commits

Reviewing files that changed from the base of the PR and between 43353c6 and 2deb133.

📒 Files selected for processing (10)

packages/genui/a2ui-catalog-extractor/AGENTS.md
packages/genui/a2ui-catalog-extractor/README.md
packages/genui/a2ui-catalog-extractor/readme.zh_cn.md
packages/genui/a2ui-catalog-extractor/test/extractor.test.ts
packages/genui/a2ui-catalog-extractor/test/fixtures/catalog/QuickStartCard.tsx
packages/genui/a2ui-catalog-extractor/test/fixtures/expected-catalog/QuickStartCard/catalog.json
website/.gitignore
website/rspress.config.ts
website/sidebars/genui.ts
website/sidebars/index.ts

docs: expand a2ui catalog extractor guide

6ec8496

docs: keep a2ui extractor guide external only

3f2c1ef

PupilTong self-assigned this Apr 27, 2026

PupilTong changed the title ~~[codex] expand a2ui catalog extractor guide~~ chore: expand a2ui catalog extractor guide Apr 27, 2026

PupilTong added 3 commits April 28, 2026 12:05

docs: add genui website sidebar

c88d1c0

docs: fix genui locale links

73cf978

docs: move genui docs into guide

2deb133

PupilTong requested review from Sherry-hue and colinaaa April 28, 2026 05:43

PupilTong marked this pull request as ready for review April 28, 2026 05:44

coderabbitai Bot reviewed Apr 28, 2026

View reviewed changes

Comment thread website/sidebars/genui.ts

colinaaa approved these changes Apr 28, 2026

View reviewed changes

PupilTong merged commit e15852f into lynx-family:main Apr 28, 2026
128 of 134 checks passed

coderabbitai Bot mentioned this pull request Apr 29, 2026

fix: catalog outputs should copy style css #2541

Open

3 tasks

Conversation

PupilTong commented Apr 27, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Validation

Summary by CodeRabbit

Uh oh!

changeset-bot Bot commented Apr 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⚠️ No Changeset found

Uh oh!

coderabbitai Bot commented Apr 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Suggested reviewers

Poem

Uh oh!

codecov Bot commented Apr 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

codspeed-hq Bot commented Apr 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Merging this PR will improve performance by 9.06%

Performance Changes

Footnotes

Uh oh!

relativeci Bot commented Apr 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

React Example

#7678 Bundle Size — 225.38KiB (0%).

Uh oh!

relativeci Bot commented Apr 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

React External

#794 Bundle Size — 680.27KiB (0%).

Uh oh!

relativeci Bot commented Apr 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Web Explorer

#9251 Bundle Size — 900.02KiB (0%).

Uh oh!

relativeci Bot commented Apr 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

React MTF Example

#810 Bundle Size — 196.54KiB (0%).

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

PupilTong commented Apr 27, 2026 •

edited by coderabbitai Bot

Loading

changeset-bot Bot commented Apr 27, 2026 •

edited

Loading

coderabbitai Bot commented Apr 27, 2026 •

edited

Loading

codecov Bot commented Apr 27, 2026 •

edited

Loading

codspeed-hq Bot commented Apr 27, 2026 •

edited

Loading

relativeci Bot commented Apr 27, 2026 •

edited

Loading

relativeci Bot commented Apr 27, 2026 •

edited

Loading

relativeci Bot commented Apr 27, 2026 •

edited

Loading

relativeci Bot commented Apr 27, 2026 •

edited

Loading