Skip to content

Website: Remove docusaurus-plugin-internaldocs-fb - #2189

Draft
vzaidman wants to merge 3 commits into
react:mainfrom
vzaidman:vzaidman/remove-internaldocs-plugin
Draft

vzaidman wants to merge 3 commits into
react:mainfrom
vzaidman:vzaidman/remove-internaldocs-plugin

Conversation

@vzaidman

@vzaidman vzaidman commented Nov 6, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Stacked on #2178. Review only the last commit.

The website uses @docusaurus/preset-classic directly instead of the docusaurus-plugin-internaldocs-fb preset that wraps it. The external build keeps its edit links, last updated times, Algolia search and analytics. The preset's other additions (remark plugins for snippets and Mermaid, its theme components) are unused by the docs.

Changelog: [Internal]

Test plan

  • yarn build in website/ (Node 22) succeeds and generates the same 13 pages under /docs/.
  • In the built docs/configuration/index.html: the edit link points to https://github.com/react/metro/edit/main/docs/../docs/Configuration.md, as before, and the page has the "Last updated" date, DocSearch and the gtag ID.
  • prettier --check passes on the changed files.

@meta-cla meta-cla Bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Nov 6, 2026
@vzaidman
vzaidman force-pushed the vzaidman/remove-internaldocs-plugin branch 4 times, most recently from be547c1 to 70282b5 Compare November 6, 2026 13:03
Adds `AGENTS.md`, instructions for coding agents working on Metro:

- Docs: they are in `docs/`. Read them to understand Metro's intended behavior, update them in the same change when it affects behavior they describe, and flag changes that make them inaccurate when reviewing.
- Benchmarks: measure performance-sensitive changes with `scripts/benchmark-patches/benchmark-patches.js`, and offer to benchmark when making or reviewing them.

Changelog: [Internal]
The website build checks links between doc pages (`onBrokenLinks`, `onBrokenAnchors`), but it only ran as part of the deploy, when a commit landed on `main`. A PR that broke a link was green and then broke the deploy.

Adds `preview-website.yml`, which runs `yarn build` in `website/` on PRs that touch `docs/**` or `website/`. In forks, it also runs on pushed branches and publishes each one as a preview at `https://<owner>.github.io/<repo>/<branch>/`, once the fork owner enables workflows and GitHub Pages from the `gh-pages` branch. "Export to GitHub" pushes to the author's fork by default, so exported diffs get previews too.

`WEBSITE_BASE_URL` overrides the website's `baseUrl`. The help page links use `Link`, so they follow it.

Adds a `website-install` composite action, like `yarn-install`, that sets up Node with the yarn cache for `website/yarn.lock` and installs the website's dependencies. `preview-website.yml` and `deploy-website.yml` use it, so `deploy-website.yml` no longer restores the yarn cache by hand. `preview-website.yml` also runs when the action changes.

Changelog: [Internal]
The website uses `@docusaurus/preset-classic` directly instead of the `docusaurus-plugin-internaldocs-fb` preset that wraps it. The external build keeps its edit links, last updated times, Algolia search and analytics. The preset's other additions (remark plugins for snippets and Mermaid, its theme components) are unused by the docs.

Changelog: [Internal]
@vzaidman
vzaidman force-pushed the vzaidman/remove-internaldocs-plugin branch from 70282b5 to 743790e Compare November 6, 2026 13:25

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant