docs: fix package readme consistency (facebook#11721)

slorber · web-flow · commit 5997f3ab3ced · 2026-02-06T19:18:10.000+01:00
diff --git a/packages/docusaurus-remark-plugin-npm2yarn/README.md b/packages/docusaurus-remark-plugin-npm2yarn/README.md
@@ -1,4 +1,4 @@
-# Remark plugin npm2yarn
+# `@docusaurus/remark-plugin-npm2yarn`
 
 ## Motivation:
 
diff --git a/packages/docusaurus-theme-classic/README.md b/packages/docusaurus-theme-classic/README.md
@@ -1,4 +1,4 @@
-# Docusaurus Theme Classic
+# `@docusaurus/theme-classic`
 
 The classic theme for Docusaurus.
 
diff --git a/packages/docusaurus-theme-live-codeblock/README.md b/packages/docusaurus-theme-live-codeblock/README.md
@@ -1,4 +1,4 @@
-# Docusaurus Live Codeblock
+# `@docusaurus/theme-live-codeblock`
 
 You can create live code editors with a code block `live` meta string.
 
diff --git a/packages/docusaurus-theme-mermaid/README.md b/packages/docusaurus-theme-mermaid/README.md
@@ -1,4 +1,4 @@
-# Docusaurus Theme Mermaid
+# `@docusaurus/theme-mermaid`
 
 The mermaid components for Docusaurus.
 
diff --git a/packages/docusaurus-theme-translations/README.md b/packages/docusaurus-theme-translations/README.md
@@ -1,4 +1,4 @@
-# Docusaurus theme translations
+# `@docusaurus/theme-translations`
 
 This package includes default translations for labels (like the pagination "Next" / "Previous") used by official Docusaurus themes.
 
diff --git a/packages/docusaurus-tsconfig/README.md b/packages/docusaurus-tsconfig/README.md
@@ -0,0 +1,3 @@
+# `@docusaurus/tsconfig`
+
+Base TypeScript configuration for Docusaurus websites
diff --git a/packages/docusaurus-tsconfig/package.json b/packages/docusaurus-tsconfig/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@docusaurus/tsconfig",
   "version": "3.9.2",
-  "description": "Docusaurus base TypeScript configuration.",
+  "description": "Base TypeScript configuration for Docusaurus websites",
   "main": "tsconfig.json",
   "publishConfig": {
     "access": "public"
diff --git a/packages/docusaurus-utils-common/README.md b/packages/docusaurus-utils-common/README.md
@@ -1,3 +1,3 @@
-# `@docusaurus/utils`
+# `@docusaurus/utils-common`
 
 Common (Node/Browser) utility functions for Docusaurus packages.
diff --git a/packages/docusaurus/README.md b/packages/docusaurus/README.md
@@ -1 +1,3 @@
-# Docusaurus core
+# `@docusaurus/core`
+
+The core package of Docusaurus

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# Remark plugin npm2yarn`
	`1`	+# `@docusaurus/remark-plugin-npm2yarn`
`2`	`2`
`3`	`3`	`## Motivation:`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# Docusaurus Theme Classic`
	`1`	+# `@docusaurus/theme-classic`
`2`	`2`
`3`	`3`	`The classic theme for Docusaurus.`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# Docusaurus Live Codeblock`
	`1`	+# `@docusaurus/theme-live-codeblock`
`2`	`2`
`3`	`3`	You can create live code editors with a code block `live` meta string.
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# Docusaurus Theme Mermaid`
	`1`	+# `@docusaurus/theme-mermaid`
`2`	`2`
`3`	`3`	`The mermaid components for Docusaurus.`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# Docusaurus theme translations`
	`1`	+# `@docusaurus/theme-translations`
`2`	`2`
`3`	`3`	`This package includes default translations for labels (like the pagination "Next" / "Previous") used by official Docusaurus themes.`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	+# `@docusaurus/tsconfig`
	`2`	`+`
	`3`	`+Base TypeScript configuration for Docusaurus websites`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@docusaurus/tsconfig",`
`3`	`3`	`"version": "3.9.2",`
`4`		`- "description": "Docusaurus base TypeScript configuration.",`
	`4`	`+ "description": "Base TypeScript configuration for Docusaurus websites",`
`5`	`5`	`"main": "tsconfig.json",`
`6`	`6`	`"publishConfig": {`
`7`	`7`	`"access": "public"`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`		-# `@docusaurus/utils`
	`1`	+# `@docusaurus/utils-common`
`2`	`2`
`3`	`3`	`Common (Node/Browser) utility functions for Docusaurus packages.`