docs: restructure A2UI readmes#2742
Conversation
|
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (3)
✅ Files skipped from review due to trivial changes (1)
📝 WalkthroughWalkthroughCondenses A2UI package READMEs into v0.9 quick-starts, adds EN/ZH architecture, catalogs, and custom-component docs, updates catalog recipes to include basicFunctions, revises playground/build guidance, integrates generated docs into the website sidebar, expands package publish globs, and adds api-extractor entry-point wait logic. ChangesA2UI Documentation and Website Integration
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Merging this PR will degrade performance by 14.98%
|
| Benchmark | BASE |
HEAD |
Efficiency | |
|---|---|---|---|---|
| ❌ | transform 1000 view elements |
40.2 ms | 47.3 ms | -14.98% |
Tip
Investigate this regression by commenting @codspeedbot fix this regression on this PR, or directly use the CodSpeed MCP with your agent.
Comparing PupilTong:hw/codex/a2ui-docs (3f1ff98) with main (076fc63)
Footnotes
-
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. ↩
PupilTong
changed the title
PupilTong
requested review from
HuJean,
Sherry-hue,
fzx2666-fz and
gaoachao
as code owners
PupilTong
changed the title
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In @.github/a2ui-catalog.instructions.md:
- Line 35: Update the guidance sentence to accurately state that the package
build script runs TypeScript compilation before regenerating the catalog:
replace the current claim that `pnpm -F `@lynx-js/genui-a2ui` build` only
regenerates catalog JSON with a sentence noting that the `build` script runs
`tsc --project tsconfig.build.json` (or `exec tsc -p tsconfig.build.json`)
before `build:catalog`, so you normally don't need to run a separate `tsc`
unless you specifically skip the package's `build` step.
🪄 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: 30a54be4-c115-409e-82dd-2c5854721c20
📒 Files selected for processing (13)
.github/a2ui-catalog.instructions.mdpackages/genui/a2ui/README.mdpackages/genui/a2ui/README_zh.mdpackages/genui/a2ui/docs/architecture.mdpackages/genui/a2ui/docs/architecture_zh.mdpackages/genui/a2ui/docs/catalogs.mdpackages/genui/a2ui/docs/catalogs_zh.mdpackages/genui/a2ui/docs/custom-components.mdpackages/genui/a2ui/docs/custom-components_zh.mdpackages/genui/a2ui/src/catalog/README.mdpackages/genui/a2ui/src/catalog/readme_zh.mdwebsite/rspress.config.tswebsite/sidebars/genui.ts
PupilTong
force-pushed
the
hw/codex/a2ui-docs
branch
from
93b6488 to
aed6715
Compare
PupilTong
changed the title
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@website/rspress.config.ts`:
- Around line 758-759: The activeMatch regex for the A2UI nav (property
activeMatch) currently only matches English routes and misses Chinese pages;
update the regex used in the activeMatch for A2UI so it also accepts the
optional "/zh/" prefix (so it will match both "/a2ui" and "/zh/a2ui" and
similarly for "/guide/genui/a2ui"), leaving the items reference
(A2UI_EN_NAV_ITEMS) unchanged.
🪄 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: 55ad1305-47e7-40a2-94fe-ea66d1a15663
📒 Files selected for processing (14)
.github/a2ui-catalog.instructions.mdpackages/genui/a2ui/README.mdpackages/genui/a2ui/README_zh.mdpackages/genui/a2ui/docs/architecture.mdpackages/genui/a2ui/docs/architecture_zh.mdpackages/genui/a2ui/docs/catalogs.mdpackages/genui/a2ui/docs/catalogs_zh.mdpackages/genui/a2ui/docs/custom-components.mdpackages/genui/a2ui/docs/custom-components_zh.mdpackages/genui/a2ui/src/catalog/README.mdpackages/genui/a2ui/src/catalog/readme_zh.mdpackages/genui/package.jsonwebsite/rspress.config.tswebsite/sidebars/genui.ts
✅ Files skipped from review due to trivial changes (10)
- packages/genui/a2ui/docs/catalogs_zh.md
- packages/genui/a2ui/README_zh.md
- packages/genui/a2ui/docs/custom-components_zh.md
- packages/genui/a2ui/docs/custom-components.md
- packages/genui/a2ui/docs/architecture.md
- packages/genui/a2ui/docs/catalogs.md
- packages/genui/a2ui/README.md
- packages/genui/a2ui/src/catalog/readme_zh.md
- .github/a2ui-catalog.instructions.md
- packages/genui/a2ui/src/catalog/README.md
🚧 Files skipped from review as they are similar to previous changes (2)
- packages/genui/package.json
- website/sidebars/genui.ts
|
Actionable comments posted: 0 |
3 participants
Summary
basicFunctions,ChoicePicker, andDateTimeInput, and record the README maintenance guidance./a2ui, and generate website routes for the A2UI root/topic/catalog README docs.packages/genui/a2ui-playground; the playground entry now links directly to/a2uiinstead of adding playground README docs.fileswhitelist with A2UI markdown globs so the split README/docs files are included in npm packs.Validation
./node_modules/.bin/dprint check --incremental=false ..../node_modules/.bin/eslint --no-warn-ignored website/rspress.config.ts website/sidebars/genui.tsgit diff --check --cachednpm pack --dry-run --jsonforpackages/genuiwith a temp npm cache, filtered to confirm A2UI markdown files are included.createGenUIGuideReadmeDocs(...)and confirmed rewritten links.git diff --name-status upstream/main...HEAD -- packages/genui/a2ui-playgroundis empty after the revert.websitetypecheck is still blocked by the existingwebsite/src/components/Columns.tsxexact optional property error.rspress buildis still blocked until API temp files such aswebsite/temp/react.api.jsonare generated.Summary by CodeRabbit
Documentation
Website
Chores