docs: fix package readme consistency by slorber · Pull Request #11721 · facebook/docusaurus

slorber · 2026-02-06T18:11:08Z

Motivation

While manually configuring each npm package for trusted publishing on npm, I noticed some readme errors/inconsistencies.

Not a big deal, but let's normalize them a bit better

netlify · 2026-02-06T18:13:59Z

✅ [V2]

Name	Link
🔨 Latest commit	`6c1ba6f`
🔍 Latest deploy log	https://app.netlify.com/projects/docusaurus-2/deploys/69862ebff960d7000841ffe3
😎 Deploy Preview	https://deploy-preview-11721--docusaurus-2.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

github-actions · 2026-02-06T18:15:16Z

Size Change: +48 B (0%)

Total Size: 11.8 MB

Filename	Size	Change
`website/.docusaurus/docusaurus.config.mjs`	28.9 kB	-57 B (-0.2%)
`website/build/assets/js/main.********.js`	747 kB	-45 B (-0.01%)

ℹ️ View Unchanged

Filename	Size	Change
`website/.docusaurus/codeTranslations.json`	2 B	0 B
`website/.docusaurus/globalData.json`	38.5 kB	0 B
`website/.docusaurus/i18n.json`	1.36 kB	0 B
`website/.docusaurus/registry.js`	177 kB	0 B
`website/.docusaurus/routes.js`	88.2 kB	0 B
`website/.docusaurus/routesChunkNames.json`	92.2 kB	0 B
`website/.docusaurus/site-metadata.json`	2.54 kB	0 B
`website/build/assets/css/styles.********.css`	145 kB	0 B
`website/build/assets/js/runtime~main.********.js`	39.1 kB	0 B
`website/build/blog.html`	77.1 kB	0 B
`website/build/blog/2017/12/14/introducing-docusaurus.html`	65.5 kB	-1 B (0%)
`website/build/blog/2018/04/30/How-I-Converted-Profilo-To-Docusaurus.html`	44.8 kB	+11 B (+0.02%)
`website/build/blog/2018/09/11/Towards-Docusaurus-2.html`	49.2 kB	-1 B (0%)
`website/build/blog/2018/12/14/Happy-First-Birthday-Slash.html`	29 kB	-1 B (0%)
`website/build/blog/2019/12/30/docusaurus-2019-recap.html`	40 kB	-2 B (-0.01%)
`website/build/blog/2020/01/07/tribute-to-endi.html`	32.6 kB	-1 B (0%)
`website/build/blog/2021/01/19/docusaurus-2020-recap.html`	51.4 kB	-1 B (0%)
`website/build/blog/2021/03/09/releasing-docusaurus-i18n.html`	47.3 kB	-2 B (0%)
`website/build/blog/2021/05/12/announcing-docusaurus-two-beta.html`	48 kB	-1 B (0%)
`website/build/blog/2021/11/21/algolia-docsearch-migration.html`	54.2 kB	+11 B (+0.02%)
`website/build/blog/2022/01/24/docusaurus-2021-recap.html`	43.3 kB	-1 B (0%)
`website/build/blog/2022/08/01/announcing-docusaurus-2.0.html`	133 kB	-1 B (0%)
`website/build/blog/2022/09/01/docusaurus-2.1.html`	50.1 kB	-2 B (0%)
`website/build/blog/archive.html`	23.5 kB	0 B
`website/build/blog/authors.html`	50.3 kB	0 B
`website/build/blog/authors/j-marcey.html`	70.2 kB	0 B
`website/build/blog/authors/josh-cena.html`	46.7 kB	0 B
`website/build/blog/authors/lex-111.html`	55.5 kB	0 B
`website/build/blog/authors/slorber.html`	80.6 kB	0 B
`website/build/blog/authors/slorber/page/2.html`	80.7 kB	0 B
`website/build/blog/authors/slorber/page/3.html`	82.9 kB	0 B
`website/build/blog/authors/slorber/page/4.html`	97.4 kB	0 B
`website/build/blog/authors/slorber/page/5.html`	42.2 kB	0 B
`website/build/blog/authors/yangshun.html`	66.1 kB	0 B
`website/build/blog/authors/zpao.html`	47.2 kB	0 B
`website/build/blog/page/2.html`	77.2 kB	0 B
`website/build/blog/page/3.html`	80.2 kB	0 B
`website/build/blog/page/4.html`	87.5 kB	0 B
`website/build/blog/page/5.html`	62.4 kB	0 B
`website/build/blog/page/6.html`	38 kB	0 B
`website/build/blog/preparing-your-site-for-docusaurus-v3.html`	125 kB	+3 B (0%)
`website/build/blog/releases/2.2.html`	50.3 kB	-1 B (0%)
`website/build/blog/releases/2.3.html`	60.6 kB	-1 B (0%)
`website/build/blog/releases/2.4.html`	64.1 kB	-1 B (0%)
`website/build/blog/releases/3.0.html`	105 kB	-1 B (0%)
`website/build/blog/releases/3.1.html`	53.1 kB	0 B
`website/build/blog/releases/3.2.html`	48.9 kB	-1 B (0%)
`website/build/blog/releases/3.3.html`	55.9 kB	-1 B (0%)
`website/build/blog/releases/3.4.html`	55.1 kB	+6 B (+0.01%)
`website/build/blog/releases/3.5.html`	57.8 kB	0 B
`website/build/blog/releases/3.6.html`	76 kB	0 B
`website/build/blog/releases/3.7.html`	50.6 kB	0 B
`website/build/blog/releases/3.8.html`	85.4 kB	-1 B (0%)
`website/build/blog/releases/3.9.html`	60.4 kB	-1 B (0%)
`website/build/blog/tags.html`	27.2 kB	0 B
`website/build/blog/upgrading-frontend-dependencies-with-confidence-using-visual-regression-testing.html`	123 kB	-1 B (0%)
`website/build/docs.html`	48.4 kB	-1 B (0%)
`website/build/docs/advanced.html`	30 kB	-1 B (0%)
`website/build/docs/advanced/architecture.html`	29.5 kB	+3 B (+0.01%)
`website/build/docs/advanced/client.html`	68.5 kB	-1 B (0%)
`website/build/docs/advanced/plugins.html`	54 kB	-1 B (0%)
`website/build/docs/advanced/routing.html`	69 kB	+7 B (+0.01%)
`website/build/docs/advanced/ssg.html`	73.1 kB	-1 B (0%)
`website/build/docs/api/docusaurus-config.html`	227 kB	+9 B (0%)
`website/build/docs/api/misc/@docusaurus/eslint-plugin.html`	44 kB	+3 B (+0.01%)
`website/build/docs/api/misc/@docusaurus/eslint-plugin/no-html-links.html`	35.5 kB	-1 B (0%)
`website/build/docs/api/misc/@docusaurus/eslint-plugin/no-untranslated-text.html`	34.6 kB	-1 B (0%)
`website/build/docs/api/misc/@docusaurus/eslint-plugin/prefer-docusaurus-heading.html`	35.8 kB	+3 B (+0.01%)
`website/build/docs/api/misc/@docusaurus/eslint-plugin/string-literal-i18n-messages.html`	39.4 kB	-1 B (0%)
`website/build/docs/api/misc/@docusaurus/logger.html`	38 kB	-1 B (0%)
`website/build/docs/api/misc/create-docusaurus.html`	33.1 kB	-1 B (0%)
`website/build/docs/api/misc/docusaurus-init/index.html`	361 B	0 B
`website/build/docs/api/plugin-methods.html`	64 kB	+3 B (0%)
`website/build/docs/api/plugin-methods/extend-infrastructure.html`	58 kB	+3 B (+0.01%)
`website/build/docs/api/plugin-methods/i18n-lifecycles.html`	56.4 kB	+3 B (+0.01%)
`website/build/docs/api/plugin-methods/lifecycle-apis.html`	157 kB	-1 B (0%)
`website/build/docs/api/plugin-methods/static-methods.html`	43.9 kB	+3 B (+0.01%)
`website/build/docs/api/plugins.html`	32.4 kB	+3 B (+0.01%)
`website/build/docs/api/plugins/@docusaurus/plugin-client-redirects.html`	58.9 kB	+12 B (+0.02%)
`website/build/docs/api/plugins/@docusaurus/plugin-content-blog.html`	182 kB	-1 B (0%)
`website/build/docs/api/plugins/@docusaurus/plugin-content-docs.html`	188 kB	-1 B (0%)
`website/build/docs/api/plugins/@docusaurus/plugin-content-pages.html`	73.3 kB	-1 B (0%)
`website/build/docs/api/plugins/@docusaurus/plugin-css-cascade-layers.html`	46.7 kB	-1 B (0%)
`website/build/docs/api/plugins/@docusaurus/plugin-debug.html`	47.3 kB	+11 B (+0.02%)
`website/build/docs/api/plugins/@docusaurus/plugin-google-analytics.html`	48.8 kB	+2 B (0%)
`website/build/docs/api/plugins/@docusaurus/plugin-google-gtag.html`	48.3 kB	-5 B (-0.01%)
`website/build/docs/api/plugins/@docusaurus/plugin-google-tag-manager.html`	47.2 kB	-1 B (0%)
`website/build/docs/api/plugins/@docusaurus/plugin-ideal-image.html`	51 kB	-1 B (0%)
`website/build/docs/api/plugins/@docusaurus/plugin-pwa.html`	115 kB	+3 B (0%)
`website/build/docs/api/plugins/@docusaurus/plugin-rsdoctor.html`	40 kB	-1 B (0%)
`website/build/docs/api/plugins/@docusaurus/plugin-sitemap.html`	64.7 kB	+5 B (+0.01%)
`website/build/docs/api/plugins/@docusaurus/plugin-svgr.html`	45 kB	-1 B (0%)
`website/build/docs/api/plugins/@docusaurus/plugin-vercel-analytics.html`	40.3 kB	+11 B (+0.03%)
`website/build/docs/api/themes.html`	29.3 kB	-1 B (0%)
`website/build/docs/api/themes/@docusaurus/theme-classic.html`	42.6 kB	+3 B (+0.01%)
`website/build/docs/api/themes/@docusaurus/theme-live-codeblock.html`	35.8 kB	+1 B (0%)
`website/build/docs/api/themes/@docusaurus/theme-mermaid.html`	34.6 kB	+3 B (+0.01%)
`website/build/docs/api/themes/@docusaurus/theme-search-algolia.html`	32.4 kB	-1 B (0%)
`website/build/docs/api/themes/configuration.html`	246 kB	-1 B (0%)
`website/build/docs/blog.html`	198 kB	-1 B (0%)
`website/build/docs/browser-support.html`	46.8 kB	-1 B (0%)
`website/build/docs/category/getting-started.html`	26.9 kB	0 B
`website/build/docs/category/guides.html`	35.6 kB	0 B
`website/build/docs/cli.html`	58.8 kB	-1 B (0%)
`website/build/docs/configuration.html`	90.1 kB	+6 B (+0.01%)
`website/build/docs/create-doc.html`	60.3 kB	+2 B (0%)
`website/build/docs/creating-pages.html`	56 kB	0 B
`website/build/docs/deployment.html`	210 kB	-2 B (0%)
`website/build/docs/docs-introduction.html`	49.6 kB	-1 B (0%)
`website/build/docs/docs-multi-instance.html`	72 kB	+3 B (0%)
`website/build/docs/docusaurus-core.html`	219 kB	-1 B (0%)
`website/build/docs/guides/whats-next.html`	32.2 kB	-1 B (0%)
`website/build/docs/i18n/crowdin.html`	141 kB	+11 B (+0.01%)
`website/build/docs/i18n/git.html`	75.4 kB	+3 B (0%)
`website/build/docs/i18n/introduction.html`	48.4 kB	-1 B (0%)
`website/build/docs/i18n/tutorial.html`	161 kB	+3 B (0%)
`website/build/docs/installation.html`	63.3 kB	-3 B (0%)
`website/build/docs/introduction/index.html`	280 B	0 B
`website/build/docs/markdown-features.html`	78.5 kB	-1 B (0%)
`website/build/docs/markdown-features/admonitions.html`	115 kB	+2 B (0%)
`website/build/docs/markdown-features/assets.html`	84.9 kB	+1 B (0%)
`website/build/docs/markdown-features/code-blocks.html`	215 kB	+6 B (0%)
`website/build/docs/markdown-features/diagrams.html`	53.8 kB	+8 B (+0.01%)
`website/build/docs/markdown-features/head-metadata.html`	50.2 kB	-1 B (0%)
`website/build/docs/markdown-features/links.html`	40.3 kB	0 B
`website/build/docs/markdown-features/math-equations.html`	88 kB	+3 B (0%)
`website/build/docs/markdown-features/plugins.html`	93.8 kB	+7 B (+0.01%)
`website/build/docs/markdown-features/react.html`	130 kB	-1 B (0%)
`website/build/docs/markdown-features/tabs.html`	137 kB	-1 B (0%)
`website/build/docs/markdown-features/toc.html`	81.7 kB	+3 B (0%)
`website/build/docs/migration.html`	38.2 kB	+3 B (+0.01%)
`website/build/docs/migration/v2.html`	38.9 kB	-1 B (0%)
`website/build/docs/migration/v2/automated.html`	39.3 kB	-1 B (0%)
`website/build/docs/migration/v2/manual.html`	185 kB	-1 B (0%)
`website/build/docs/migration/v2/translated-sites.html`	50.1 kB	-1 B (0%)
`website/build/docs/migration/v2/versioned-sites.html`	58.9 kB	+7 B (+0.01%)
`website/build/docs/migration/v3.html`	187 kB	+1 B (0%)
`website/build/docs/playground.html`	31.1 kB	-1 B (0%)
`website/build/docs/resources/index.html`	325 B	0 B
`website/build/docs/search.html`	121 kB	+1 B (0%)
`website/build/docs/seo.html`	86.3 kB	+12 B (+0.01%)
`website/build/docs/sidebar.html`	133 kB	0 B
`website/build/docs/sidebar/autogenerated.html`	143 kB	-1 B (0%)
`website/build/docs/sidebar/items.html`	170 kB	0 B
`website/build/docs/sidebar/multiple-sidebars.html`	60.8 kB	+3 B (0%)
`website/build/docs/static-assets.html`	50.9 kB	+3 B (+0.01%)
`website/build/docs/styling-layout.html`	133 kB	0 B
`website/build/docs/support/index.html`	319 B	0 B
`website/build/docs/swizzling.html`	109 kB	+13 B (+0.01%)
`website/build/docs/team/index.html`	310 B	0 B
`website/build/docs/typescript-support.html`	58.9 kB	+3 B (+0.01%)
`website/build/docs/using-plugins.html`	104 kB	-1 B (0%)
`website/build/docs/versioning.html`	89.8 kB	-3 B (0%)
`website/build/index.html`	35.5 kB	0 B

_{compressed-size-action::DOCUSAURUS_INFRA_FASTER}

github-actions · 2026-02-06T18:16:25Z

⚡️ Lighthouse report for the deploy preview of this PR

URL	Performance	Accessibility	Best Practices	SEO	Report
/	🔴 41	🟢 98	🟢 100	🟢 100	Report
/docs/installation	🟠 57	🟢 97	🟢 100	🟢 100	Report
/docs/category/getting-started	🟠 68	🟢 100	🟢 100	🟠 86	Report
/blog	🟠 67	🟢 96	🟢 100	🟠 86	Report
/blog/preparing-your-site-for-docusaurus-v3	🟠 65	🟢 92	🟢 100	🟢 100	Report
/blog/tags/release	🟠 67	🟢 96	🟢 100	🟠 86	Report
/blog/tags	🟠 67	🟢 100	🟢 100	🟠 86	Report

github-actions · 2026-02-06T18:19:34Z

Size Change: +38 B (0%)

Total Size: 12.3 MB

Filename	Size	Change
`website/.docusaurus/docusaurus.config.mjs`	28.9 kB	-57 B (-0.2%)
`website/build/assets/js/main.********.js`	749 kB	-45 B (-0.01%)

ℹ️ View Unchanged

Filename	Size	Change
`website/.docusaurus/codeTranslations.json`	2 B	0 B
`website/.docusaurus/globalData.json`	38.5 kB	0 B
`website/.docusaurus/i18n.json`	1.36 kB	0 B
`website/.docusaurus/registry.js`	177 kB	0 B
`website/.docusaurus/routes.js`	88.2 kB	0 B
`website/.docusaurus/routesChunkNames.json`	92.2 kB	0 B
`website/.docusaurus/site-metadata.json`	2.38 kB	0 B
`website/build/assets/css/styles.********.css`	137 kB	0 B
`website/build/assets/js/runtime~main.********.js`	38.8 kB	0 B
`website/build/blog.html`	79.8 kB	0 B
`website/build/blog/2017/12/14/introducing-docusaurus.html`	67.6 kB	-1 B (0%)
`website/build/blog/2018/04/30/How-I-Converted-Profilo-To-Docusaurus.html`	46.7 kB	+11 B (+0.02%)
`website/build/blog/2018/09/11/Towards-Docusaurus-2.html`	51.2 kB	-1 B (0%)
`website/build/blog/2018/12/14/Happy-First-Birthday-Slash.html`	30.6 kB	-1 B (0%)
`website/build/blog/2019/12/30/docusaurus-2019-recap.html`	41.9 kB	-2 B (0%)
`website/build/blog/2020/01/07/tribute-to-endi.html`	34.2 kB	-1 B (0%)
`website/build/blog/2021/01/19/docusaurus-2020-recap.html`	53.5 kB	-1 B (0%)
`website/build/blog/2021/03/09/releasing-docusaurus-i18n.html`	49.4 kB	-2 B (0%)
`website/build/blog/2021/05/12/announcing-docusaurus-two-beta.html`	50.1 kB	-1 B (0%)
`website/build/blog/2021/11/21/algolia-docsearch-migration.html`	56.5 kB	+11 B (+0.02%)
`website/build/blog/2022/01/24/docusaurus-2021-recap.html`	45.3 kB	-1 B (0%)
`website/build/blog/2022/08/01/announcing-docusaurus-2.0.html`	137 kB	-1 B (0%)
`website/build/blog/2022/09/01/docusaurus-2.1.html`	52.4 kB	-2 B (0%)
`website/build/blog/archive.html`	24.9 kB	0 B
`website/build/blog/authors.html`	52.5 kB	0 B
`website/build/blog/authors/j-marcey.html`	72.8 kB	0 B
`website/build/blog/authors/josh-cena.html`	48.8 kB	0 B
`website/build/blog/authors/lex-111.html`	57.9 kB	0 B
`website/build/blog/authors/slorber.html`	83.5 kB	0 B
`website/build/blog/authors/slorber/page/2.html`	83.6 kB	0 B
`website/build/blog/authors/slorber/page/3.html`	85.9 kB	0 B
`website/build/blog/authors/slorber/page/4.html`	101 kB	0 B
`website/build/blog/authors/slorber/page/5.html`	44.2 kB	0 B
`website/build/blog/authors/yangshun.html`	68.8 kB	0 B
`website/build/blog/authors/zpao.html`	49.3 kB	0 B
`website/build/blog/page/2.html`	80 kB	0 B
`website/build/blog/page/3.html`	82.9 kB	0 B
`website/build/blog/page/4.html`	90.5 kB	0 B
`website/build/blog/page/5.html`	64.8 kB	0 B
`website/build/blog/page/6.html`	39.7 kB	0 B
`website/build/blog/preparing-your-site-for-docusaurus-v3.html`	130 kB	-2 B (0%)
`website/build/blog/releases/2.2.html`	52.5 kB	-1 B (0%)
`website/build/blog/releases/2.3.html`	63.1 kB	-1 B (0%)
`website/build/blog/releases/2.4.html`	66.8 kB	-1 B (0%)
`website/build/blog/releases/3.0.html`	109 kB	-1 B (0%)
`website/build/blog/releases/3.1.html`	55.2 kB	0 B
`website/build/blog/releases/3.2.html`	51 kB	-1 B (0%)
`website/build/blog/releases/3.3.html`	58.3 kB	-1 B (0%)
`website/build/blog/releases/3.4.html`	57.4 kB	+6 B (+0.01%)
`website/build/blog/releases/3.5.html`	60.2 kB	0 B
`website/build/blog/releases/3.6.html`	79.1 kB	0 B
`website/build/blog/releases/3.7.html`	52.9 kB	0 B
`website/build/blog/releases/3.8.html`	88.6 kB	-1 B (0%)
`website/build/blog/releases/3.9.html`	62.9 kB	-1 B (0%)
`website/build/blog/tags.html`	28.9 kB	0 B
`website/build/blog/upgrading-frontend-dependencies-with-confidence-using-visual-regression-testing.html`	127 kB	-1 B (0%)
`website/build/docs.html`	50.3 kB	-1 B (0%)
`website/build/docs/advanced.html`	31.5 kB	-1 B (0%)
`website/build/docs/advanced/architecture.html`	31 kB	+3 B (+0.01%)
`website/build/docs/advanced/client.html`	71.2 kB	-1 B (0%)
`website/build/docs/advanced/plugins.html`	56.2 kB	-1 B (0%)
`website/build/docs/advanced/routing.html`	71.6 kB	+7 B (+0.01%)
`website/build/docs/advanced/ssg.html`	76.2 kB	-1 B (0%)
`website/build/docs/api/docusaurus-config.html`	235 kB	+9 B (0%)
`website/build/docs/api/misc/@docusaurus/eslint-plugin.html`	46.3 kB	+3 B (+0.01%)
`website/build/docs/api/misc/@docusaurus/eslint-plugin/no-html-links.html`	37.4 kB	-1 B (0%)
`website/build/docs/api/misc/@docusaurus/eslint-plugin/no-untranslated-text.html`	36.4 kB	-1 B (0%)
`website/build/docs/api/misc/@docusaurus/eslint-plugin/prefer-docusaurus-heading.html`	37.6 kB	+3 B (+0.01%)
`website/build/docs/api/misc/@docusaurus/eslint-plugin/string-literal-i18n-messages.html`	41.3 kB	-1 B (0%)
`website/build/docs/api/misc/@docusaurus/logger.html`	39.7 kB	-1 B (0%)
`website/build/docs/api/misc/create-docusaurus.html`	34.7 kB	-1 B (0%)
`website/build/docs/api/misc/docusaurus-init/index.html`	361 B	0 B
`website/build/docs/api/plugin-methods.html`	66.4 kB	+3 B (0%)
`website/build/docs/api/plugin-methods/extend-infrastructure.html`	60.4 kB	+3 B (0%)
`website/build/docs/api/plugin-methods/i18n-lifecycles.html`	58.6 kB	+3 B (+0.01%)
`website/build/docs/api/plugin-methods/lifecycle-apis.html`	162 kB	-1 B (0%)
`website/build/docs/api/plugin-methods/static-methods.html`	45.8 kB	+3 B (+0.01%)
`website/build/docs/api/plugins.html`	34 kB	+3 B (+0.01%)
`website/build/docs/api/plugins/@docusaurus/plugin-client-redirects.html`	61.6 kB	+12 B (+0.02%)
`website/build/docs/api/plugins/@docusaurus/plugin-content-blog.html`	190 kB	-1 B (0%)
`website/build/docs/api/plugins/@docusaurus/plugin-content-docs.html`	196 kB	-1 B (0%)
`website/build/docs/api/plugins/@docusaurus/plugin-content-pages.html`	77 kB	-1 B (0%)
`website/build/docs/api/plugins/@docusaurus/plugin-css-cascade-layers.html`	48.9 kB	-1 B (0%)
`website/build/docs/api/plugins/@docusaurus/plugin-debug.html`	49.5 kB	+11 B (+0.02%)
`website/build/docs/api/plugins/@docusaurus/plugin-google-analytics.html`	51.1 kB	+2 B (0%)
`website/build/docs/api/plugins/@docusaurus/plugin-google-gtag.html`	50.6 kB	-5 B (-0.01%)
`website/build/docs/api/plugins/@docusaurus/plugin-google-tag-manager.html`	49.4 kB	-1 B (0%)
`website/build/docs/api/plugins/@docusaurus/plugin-ideal-image.html`	53.5 kB	-1 B (0%)
`website/build/docs/api/plugins/@docusaurus/plugin-pwa.html`	120 kB	+3 B (0%)
`website/build/docs/api/plugins/@docusaurus/plugin-rsdoctor.html`	42 kB	-1 B (0%)
`website/build/docs/api/plugins/@docusaurus/plugin-sitemap.html`	67.5 kB	+5 B (+0.01%)
`website/build/docs/api/plugins/@docusaurus/plugin-svgr.html`	47.1 kB	-1 B (0%)
`website/build/docs/api/plugins/@docusaurus/plugin-vercel-analytics.html`	42.4 kB	+11 B (+0.03%)
`website/build/docs/api/themes.html`	30.8 kB	-1 B (0%)
`website/build/docs/api/themes/@docusaurus/theme-classic.html`	44.6 kB	+3 B (+0.01%)
`website/build/docs/api/themes/@docusaurus/theme-live-codeblock.html`	37.5 kB	+1 B (0%)
`website/build/docs/api/themes/@docusaurus/theme-mermaid.html`	36.3 kB	+3 B (+0.01%)
`website/build/docs/api/themes/@docusaurus/theme-search-algolia.html`	34.1 kB	-1 B (0%)
`website/build/docs/api/themes/configuration.html`	258 kB	-1 B (0%)
`website/build/docs/blog.html`	204 kB	-1 B (0%)
`website/build/docs/browser-support.html`	49.1 kB	-1 B (0%)
`website/build/docs/category/getting-started.html`	28.4 kB	0 B
`website/build/docs/category/guides.html`	37.4 kB	0 B
`website/build/docs/cli.html`	62.2 kB	-1 B (0%)
`website/build/docs/configuration.html`	93.6 kB	+6 B (+0.01%)
`website/build/docs/create-doc.html`	62.8 kB	+2 B (0%)
`website/build/docs/creating-pages.html`	58.4 kB	0 B
`website/build/docs/deployment.html`	218 kB	-2 B (0%)
`website/build/docs/docs-introduction.html`	51.9 kB	-1 B (0%)
`website/build/docs/docs-multi-instance.html`	75.2 kB	+3 B (0%)
`website/build/docs/docusaurus-core.html`	227 kB	-1 B (0%)
`website/build/docs/guides/whats-next.html`	34 kB	-1 B (0%)
`website/build/docs/i18n/crowdin.html`	146 kB	+11 B (+0.01%)
`website/build/docs/i18n/git.html`	78.6 kB	+3 B (0%)
`website/build/docs/i18n/introduction.html`	50.6 kB	-1 B (0%)
`website/build/docs/i18n/tutorial.html`	168 kB	+3 B (0%)
`website/build/docs/installation.html`	66 kB	-3 B (0%)
`website/build/docs/introduction/index.html`	280 B	0 B
`website/build/docs/markdown-features.html`	81.5 kB	-1 B (0%)
`website/build/docs/markdown-features/admonitions.html`	119 kB	+2 B (0%)
`website/build/docs/markdown-features/assets.html`	88.8 kB	+1 B (0%)
`website/build/docs/markdown-features/code-blocks.html`	223 kB	+6 B (0%)
`website/build/docs/markdown-features/diagrams.html`	56.3 kB	+8 B (+0.01%)
`website/build/docs/markdown-features/head-metadata.html`	52.5 kB	-1 B (0%)
`website/build/docs/markdown-features/links.html`	42.3 kB	0 B
`website/build/docs/markdown-features/math-equations.html`	91.9 kB	+3 B (0%)
`website/build/docs/markdown-features/plugins.html`	97.5 kB	+7 B (+0.01%)
`website/build/docs/markdown-features/react.html`	136 kB	-1 B (0%)
`website/build/docs/markdown-features/tabs.html`	143 kB	-1 B (0%)
`website/build/docs/markdown-features/toc.html`	85.2 kB	+3 B (0%)
`website/build/docs/migration.html`	40.1 kB	-2 B (0%)
`website/build/docs/migration/v2.html`	40.7 kB	-1 B (0%)
`website/build/docs/migration/v2/automated.html`	41.2 kB	-1 B (0%)
`website/build/docs/migration/v2/manual.html`	192 kB	-1 B (0%)
`website/build/docs/migration/v2/translated-sites.html`	52.3 kB	-1 B (0%)
`website/build/docs/migration/v2/versioned-sites.html`	61.3 kB	+7 B (+0.01%)
`website/build/docs/migration/v3.html`	194 kB	+1 B (0%)
`website/build/docs/playground.html`	32.6 kB	-1 B (0%)
`website/build/docs/resources/index.html`	325 B	0 B
`website/build/docs/search.html`	125 kB	+1 B (0%)
`website/build/docs/seo.html`	90.1 kB	+12 B (+0.01%)
`website/build/docs/sidebar.html`	138 kB	0 B
`website/build/docs/sidebar/autogenerated.html`	148 kB	-1 B (0%)
`website/build/docs/sidebar/items.html`	177 kB	0 B
`website/build/docs/sidebar/multiple-sidebars.html`	63.7 kB	+3 B (0%)
`website/build/docs/static-assets.html`	53.3 kB	+3 B (+0.01%)
`website/build/docs/styling-layout.html`	139 kB	0 B
`website/build/docs/support/index.html`	319 B	0 B
`website/build/docs/swizzling.html`	113 kB	+13 B (+0.01%)
`website/build/docs/team/index.html`	310 B	0 B
`website/build/docs/typescript-support.html`	61.4 kB	+3 B (0%)
`website/build/docs/using-plugins.html`	108 kB	-1 B (0%)
`website/build/docs/versioning.html`	93.6 kB	-3 B (0%)
`website/build/index.html`	37.1 kB	0 B

_{compressed-size-action::DOCUSAURUS_INFRA_SLOWER}

fix readme consistency

6c1ba6f

slorber requested a review from Josh-Cena as a code owner February 6, 2026 18:11

slorber added the pr: ignore This PR is not meaningful enough to appear in the changelog. label Feb 6, 2026

meta-cla bot added the CLA Signed Signed Facebook CLA label Feb 6, 2026

slorber merged commit 5997f3a into main Feb 6, 2026
47 checks passed

slorber deleted the slorber/fix-monorepo-package-readmy-consistency branch February 6, 2026 18:18

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

docs: fix package readme consistency#11721

docs: fix package readme consistency#11721
slorber merged 1 commit intomainfrom
slorber/fix-monorepo-package-readmy-consistency

slorber commented Feb 6, 2026

Uh oh!

netlify bot commented Feb 6, 2026

Uh oh!

github-actions bot commented Feb 6, 2026

Uh oh!

github-actions bot commented Feb 6, 2026

Uh oh!

Uh oh!

github-actions bot commented Feb 6, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Uh oh!

Conversation

slorber commented Feb 6, 2026

Motivation

Uh oh!

netlify bot commented Feb 6, 2026

✅ [V2]

Uh oh!

github-actions bot commented Feb 6, 2026

Uh oh!

github-actions bot commented Feb 6, 2026

⚡️ Lighthouse report for the deploy preview of this PR

Uh oh!

Uh oh!

github-actions bot commented Feb 6, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant