docs(api): regenerate rspeedy & typedoc API docs from lynx-stack main#1049
Merged
Conversation
Regenerate all API reference docs sourced from lynx-stack:
- rspeedy (api-documenter): sync en/zh from lynx-stack main. Adds new
members (e.g. Config.splitChunks, SourceMap.css, pluginReactLynx
enableUiSourceMap / experimental_useElementTemplate), removes dropped
ones (Config.provider, distPath.{css,js,root,...}, enableICU, ...), and
unifies the zh table format to HTML to match en (zh was a year stale).
Reconcile docs/{en,zh}/api/_meta.json nav.
- react / reactlynx-testing-library / lynx-testing-environment (typedoc):
regenerate against @lynx-js/react 0.121.1 and testing-environment 0.2.1.
react gains GlobalProps APIs, createPortal, useErrorBoundary; drops
createRoot. Document.* conceptual pages preserved.
Tooling/deps:
- bump @lynx-js/react devDep to ^0.121.1
- pin typedoc to ^0.26.11 (0.28 breaks the markdown theme)
- scripts/typedoc: rewrite absolute https://lynxjs.org links to
site-relative in generated output
- add new API terms to cspell dictionary
Change-Id: I415d0bd9d2d3a367d1be8e23a400b794d6247636
✅ Deploy Preview for lynx-doc ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Important Review skippedToo many files! This PR contains 300 files, which is 150 over the limit of 150. To get a review, narrow the scope: ⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (300)
You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ 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 |
Deploying lynx-website-next with
|
| Latest commit: |
6344dda
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://dac1f56d.lynx-website-next.pages.dev |
| Branch Preview URL: | https://docs-regen-api-rspeedy-typed.lynx-website-next.pages.dev |
The rspress build (dead-link + MDX checks) failed on two generated files:
- Interface.ByRoleOptions: typedoc-plugin-markdown does not escape MDX
braces, so `{queryFallbacks: true}` in a TSDoc comment broke the
MDX/acorn parser. Escape prose braces (matching the prior hand-fixed
output).
- Interface.LynxElement: the lynxjs.org link rewrite turned the
living-spec reference into `/living-spec/index.html`, which is a static
asset (not an rspress route) and tripped the dead-link checker. Keep
living-spec links absolute.
Harden scripts/typedoc post-processing so neither recurs on regeneration:
exclude /living-spec/ from the site-link rewrite, and escape MDX-breaking
braces (outside code fences, inline code, and the leading JSX comment).
Change-Id: I2642883e9d774e8aeaecea8c59208b169c214820
upupming
requested review from
Huxpro,
SoonIter,
Yradex,
colinaaa,
gaoachao and
icecreamx10
as code owners
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 6344dda2ce
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Regenerate all API reference docs that are sourced from lynx-stack (latest
origin/main), which had drifted out of date.rspeedy (api-documenter)
docs/{en,zh}/api/rspeedy/from lynx-stack main.Config.splitChunks,SourceMap.css,pluginReactLynxenableUiSourceMap/experimental_useElementTemplate, external-bundle preset properties, etc.Config.provider,distPath.{css,cssAsync,js,jsAsync,root},minify.cssOptions,pluginReactLynxenableICU/enableParallelElement/pipelineSchedulerConfig/jsx.docs/{en,zh}/api/_meta.jsonsidebar nav (added/removed entries, no dead links).typedoc (
react,reactlynx-testing-library,lynx-testing-environment)@lynx-js/react0.121.1 and@lynx-js/testing-environment0.2.1.react: gains GlobalProps APIs (useGlobalProps,GlobalPropsProvider, …),createPortal,useErrorBoundary; dropscreateRoot. The hand-authoredDocument.*conceptual pages and custom index intro are preserved.reactlynx-testing-library: newact, removedprettyFormat, refreshed setup docs (now covers Rstest).lynx-testing-environment: newinstallLynxTestingEnv/uninstallLynxTestingEnv/GlobalEventEmitter/LynxEnv.Tooling / deps
@lynx-js/reactdevDep to^0.121.1.typedocto^0.26.11—0.28breaks the markdown theme (docs_generated_at_0); the plugins' peers require0.26.x.scripts/typedoc/run-typedoc.ts: post-process hook that rewrites absolutehttps://lynxjs.org/...links to site-relative/...in generated output, so future regenerations don't reintroduce hardcoded hosts.Verification
pnpm run check-docspasses._meta.jsonvalid (en/zh in sync), no dead nav links, no broken cross-links, no leftover scaffolding.Notes / caveats
@lynx-js/testing-environment@0.2.1is not published to npm (the devDep still aliases the oldtest-environment@0.0.1); these docs were generated from a local lynx-stack main build. Regen will need the new package once published.@lynx-js/react@0.121.1no longer shipstesting-library/README.md, so the rltl index README was fed from lynx-stack source during generation (upstream packaging issue worth a separate fix).