Repository navigation
docs: align contributor guidance with the current monorepo - #1449
fhammerschmidt wants to merge 2 commits into
Conversation
Document the workspace paths, docs SSR and guide deployment, current MDX pipeline, compiler sources, staged formatting hooks, and generated output policy. Clarify link-check working directories and CI behavior, recommend Oxc in VS Code, and ignore bundled Yarn releases by pattern. Refs #1417 and #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. |
Deploying with
|
| Status | Name | Latest Commit | Preview URL | Updated (UTC) |
|---|---|---|---|---|
| ✅ Deployment successful! View logs |
guide | 19daf80 | Commit Preview URL Branch Preview URL |
Oct 11 2026, 11:18 PM |
Lighthouse baselineCompared with target branch
Download the full Lighthouse reports and baseline Commit |
![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: 4ea200d921
ℹ️ 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".
Document separate docs and guide production builds and Vitest commands. Run Oxfmt and ReScript formatting from the monorepo root, with the docs alias delegating there, so all four workspaces are covered.
This branch was successfully deployed
1 participant
Contributor and agent instructions still described the old single-app layout, Prettier tooling, and a removed MDX integration. Align the guidance with the current monorepo and documented commands with the scripts they invoke.
Fixes #1417. Part of #1421.
/try, the guide's Worker deployment and separate CSS, the current@mdx-js/mdxcompilation/component mapping, and published browser compiler bundles versus the installed example-check compiler.yarn testchecks, the working directory for direct script commands, the example checker's glob scope, and the link checker's full-tree scan and CI-only failure status.Branch:
fix/1421-repo-docs, based on websitemaster(v12), pushed directly torescript-lang/rescript-lang.org. No compiler repository changes.Validation: repository-wide Oxfmt check passes; all 20 relative Markdown links and heading targets resolve; documented Yarn version and JSON configuration agree with the pinned release. The documented targeted example command passes for
manual/module-functions.mdx, and the link check fromapps/docspasses withCI=1. Eight temporary.res/.resiprobes confirm that root formatting repairs sources in all four workspaces, and both formatter checks pass after removing the probes. No application source or screenshots changed. CI is running for the review fixes.Related work: #1447 updates local test and screenshot workflows; #1448 adds ReScript formatting and generated-output CI checks. Its two formatting-script changes are also included here so these instructions work independently; those script changes are identical in both PRs.