Repository navigation
fix: load API docs from published compiler data - #1432
fhammerschmidt wants to merge 5 commits into
Conversation
Use the repository-root compiler publication for API routes, navigation, and module content. Select the latest dataset within the configured docs major and share version selection with link validation. Remove obsolete snapshots, the unused TOC, and the legacy generator. Add regression coverage for version selection, published data, and API links. Fixes rescript-lang#1391 Part of rescript-lang#1421
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
![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: 8a6f1992eb
ℹ️ 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".
Require each library root and validate module fields before caching published API data. Fail invalid publications with their file and module paths instead of prerendering blank pages. Add regression coverage for empty libraries, missing roots, and malformed root or child modules. Document the required publication structure. Fixes rescript-lang#1391 Part of rescript-lang#1421
|
@codex review |
|
Codex Review: Didn't find any major issues. Nice work! Reviewed commit: ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
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". |
Integrate master through rescript-lang#1430 while retaining the published API data lookup and monorepo regression fixtures. Preserve exact route validation without duplicating the API route list during the merge.
Move the build-time route table to native JavaScript so React Router and route generation share one configuration without requiring compiled ReScript first. Generate the shared Path.res before compilation, handle nested layouts and index routes, omit URL patterns, and detect stale output in CI. Add regression tests for content discovery, deterministic output, and non-writing checks from any working directory. Fixes rescript-lang#1408. Part of rescript-lang#1421.
Integrate rescript-lang#1442, keep API routes on the published v12 dataset, and regenerate Path.res from that dataset. Remove the superseded ReScript route table without restoring legacy API JSON. Merge rescript-lang#1442 before this PR. Fixes rescript-lang#1391. Part of rescript-lang#1421.
This branch has not been deployed
1 participant
The API reference advertised v12 (latest) while reading the old v12.0.0-rc.5 snapshots inside
apps/docs. The compiler already publishes newer data to the repository-rootdata/apidirectory, but route generation and page loaders never consumed it.This makes the compiler publication the source for API routes, sidebar navigation, and page content. The website selects the newest numeric version matching its configured documentation major, currently
v12.3.1, and rejects missing, incomplete, or invalid publications. Each library must contain its root module, and all modules are validated before the snapshot is cached. Data is loaded on demand so importing route modules does not read API snapshots during runtime SSR.apps/docs/docs-version.jsonand version selection between ReScript loaders and the Node link checker.master. Adapt the three link-checker regression fixtures to the monorepo publication layout.Targets website
master(v12). No compiler repository changes are needed. The loader supports selecting v13 publications; the website v13 port is tracked in #1433, alongside the compiler publication issue.Validation: strict ReScript compilation, all 79 Node-mode script tests, and the seven route-generation tests pass after integration with #1442. The production build passes, and all 139 published API modules have prerendered HTML and loader data. All six CI jobs pass after integration, including route freshness, site checks, browser and visual regression tests, Wrangler startup, and homepage end-to-end tests.
Fixes #1391
Part of #1421