docs: fix typedoc links and add missing packages (#5850)

facebook · Apr 14, 2024 · a951969 · a951969
1 parent db1265a
commit a951969
Show file tree

Hide file tree

Showing 57 changed files with 132 additions and 82 deletions.
diff --git a/.eslintignore b/.eslintignore
@@ -11,3 +11,5 @@
 **/vite.prod.config.js
 **/node_modules
 .ts-temp
+**/.docusaurus
+/playwright-report
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -76,13 +76,6 @@ module.exports = {
         'header/header': [2, 'scripts/www/headerTemplate.js'],
       },
     },
-    {
-      // don't lint headers in entrypoint files so we can add TypeDoc module comments
-      files: ['packages/**/src/index.ts'],
-      rules: {
-        'header/header': OFF,
-      },
-    },
     {
       // These aren't compiled, but they're written in module JS
       files: ['packages/lexical-playground/esm/*.mjs'],

diff --git a/.prettierignore b/.prettierignore
@@ -16,3 +16,5 @@ packages/**/vite.prod.config.js
 flow-typed
 .github/CODEOWNERS
 .prettierignore
+**/.docusaurus
+/playwright-report
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/lexical-clipboard/src/index.ts b/packages/lexical-clipboard/src/index.ts
@@ -1,4 +1,3 @@
-/** @module @lexical/clipboard */
 /**
  * Copyright (c) Meta Platforms, Inc. and affiliates.
  *

diff --git a/packages/lexical-code/src/index.ts b/packages/lexical-code/src/index.ts
@@ -1,11 +1,9 @@
-/** @module @lexical/code */
 /**
  * Copyright (c) Meta Platforms, Inc. and affiliates.
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- *
  */
 
 export {

diff --git a/packages/lexical-devtools-core/README.md b/packages/lexical-devtools-core/README.md
@@ -1,5 +1,5 @@
 # `@lexical/devtools-core`
 
-[![See API Documentation](https://lexical.dev/img/see-api-documentation.svg)](https://lexical.dev/docs/api/modules/lexical_devtools-core)
+[![See API Documentation](https://lexical.dev/img/see-api-documentation.svg)](https://lexical.dev/docs/api/modules/lexical_devtools_core)
 
 This package contains tools necessary to debug and develop Lexical.
diff --git a/packages/lexical-devtools-core/src/index.ts b/packages/lexical-devtools-core/src/index.ts
@@ -1,4 +1,3 @@
-/** @module @lexical/devtools-core */
 /**
  * Copyright (c) Meta Platforms, Inc. and affiliates.
  *

diff --git a/packages/lexical-dragon/src/index.ts b/packages/lexical-dragon/src/index.ts
@@ -1,11 +1,9 @@
-/** @module @lexical/dragon */
 /**
  * Copyright (c) Meta Platforms, Inc. and affiliates.
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- *
  */
 
 import {

diff --git a/packages/lexical-file/src/index.ts b/packages/lexical-file/src/index.ts
@@ -1,4 +1,3 @@
-/** @module @lexical/file */
 /**
  * Copyright (c) Meta Platforms, Inc. and affiliates.
  *

diff --git a/packages/lexical-hashtag/src/index.ts b/packages/lexical-hashtag/src/index.ts
@@ -1,4 +1,3 @@
-/** @module @lexical/hashtag */
 /**
  * Copyright (c) Meta Platforms, Inc. and affiliates.
  *

diff --git a/packages/lexical-headless/src/index.ts b/packages/lexical-headless/src/index.ts
@@ -1,4 +1,3 @@
-/** @module @lexical/headless */
 /**
  * Copyright (c) Meta Platforms, Inc. and affiliates.
  *

diff --git a/packages/lexical-history/src/index.ts b/packages/lexical-history/src/index.ts
@@ -1,4 +1,3 @@
-/** @module @lexical/history */
 /**
  * Copyright (c) Meta Platforms, Inc. and affiliates.
  *

diff --git a/packages/lexical-html/src/index.ts b/packages/lexical-html/src/index.ts
@@ -1,4 +1,3 @@
-/** @module @lexical/html */
 /**
  * Copyright (c) Meta Platforms, Inc. and affiliates.
  *

diff --git a/packages/lexical-link/src/index.ts b/packages/lexical-link/src/index.ts
@@ -1,4 +1,3 @@
-/** @module @lexical/link */
 /**
  * Copyright (c) Meta Platforms, Inc. and affiliates.
  *

diff --git a/packages/lexical-list/src/index.ts b/packages/lexical-list/src/index.ts
@@ -1,4 +1,3 @@
-/** @module @lexical/list */
 /**
  * Copyright (c) Meta Platforms, Inc. and affiliates.
  *

diff --git a/packages/lexical-mark/src/index.ts b/packages/lexical-mark/src/index.ts
@@ -1,4 +1,3 @@
-/** @module @lexical/mark */
 /**
  * Copyright (c) Meta Platforms, Inc. and affiliates.
  *

diff --git a/packages/lexical-markdown/src/index.ts b/packages/lexical-markdown/src/index.ts
@@ -1,4 +1,3 @@
-/** @module @lexical/markdown */
 /**
  * Copyright (c) Meta Platforms, Inc. and affiliates.
  *

diff --git a/packages/lexical-offset/src/index.ts b/packages/lexical-offset/src/index.ts
@@ -1,4 +1,3 @@
-/** @module @lexical/offset */
 /**
  * Copyright (c) Meta Platforms, Inc. and affiliates.
  *

diff --git a/packages/lexical-overflow/src/index.ts b/packages/lexical-overflow/src/index.ts
@@ -1,4 +1,3 @@
-/** @module @lexical/overflow */
 /**
  * Copyright (c) Meta Platforms, Inc. and affiliates.
  *

diff --git a/packages/lexical-plain-text/src/index.ts b/packages/lexical-plain-text/src/index.ts
@@ -1,4 +1,3 @@
-/** @module @lexical/plain-text */
 /**
  * Copyright (c) Meta Platforms, Inc. and affiliates.
  *

diff --git a/packages/lexical-rich-text/src/index.ts b/packages/lexical-rich-text/src/index.ts
@@ -1,4 +1,3 @@
-/** @module @lexical/rich-text */
 /**
  * Copyright (c) Meta Platforms, Inc. and affiliates.
  *

diff --git a/packages/lexical-selection/src/index.ts b/packages/lexical-selection/src/index.ts
@@ -1,4 +1,3 @@
-/** @module @lexical/selection */
 /**
  * Copyright (c) Meta Platforms, Inc. and affiliates.
  *

diff --git a/packages/lexical-table/src/index.ts b/packages/lexical-table/src/index.ts
@@ -1,4 +1,3 @@
-/** @module @lexical/table */
 /**
  * Copyright (c) Meta Platforms, Inc. and affiliates.
  *

diff --git a/packages/lexical-text/src/index.ts b/packages/lexical-text/src/index.ts
@@ -1,4 +1,3 @@
-/** @module @lexical/text */
 /**
  * Copyright (c) Meta Platforms, Inc. and affiliates.
  *

diff --git a/packages/lexical-utils/src/index.ts b/packages/lexical-utils/src/index.ts
@@ -1,4 +1,3 @@
-/** @module @lexical/utils */
 /**
  * Copyright (c) Meta Platforms, Inc. and affiliates.
  *

diff --git a/packages/lexical-website/docs/packages/lexical-clipboard.md b/packages/lexical-website/docs/packages/lexical-clipboard.md
@@ -1,8 +1,6 @@
 ---
 title: ''
-sidebar_position: 7
 sidebar_label: '@lexical/clipboard'
-cache_reset: 1
 ---
 
 {@import ../../../lexical-clipboard/README.md}
diff --git a/packages/lexical-website/docs/packages/lexical-code.md b/packages/lexical-website/docs/packages/lexical-code.md
@@ -1,8 +1,6 @@
 ---
 title: ''
-sidebar_position: 13
 sidebar_label: '@lexical/code'
-cache_reset: 1
 ---
 
 {@import ../../../lexical-code/README.md}
diff --git a/packages/lexical-website/docs/packages/lexical-devtools-core.md b/packages/lexical-website/docs/packages/lexical-devtools-core.md
@@ -1,8 +1,6 @@
 ---
 title: ''
-sidebar_position: 20
 sidebar_label: '@lexical/devtools-core'
-cache_reset: 1
 ---
 
 {@import ../../../lexical-devtools-core/README.md}
diff --git a/packages/lexical-website/docs/packages/lexical-dragon.md b/packages/lexical-website/docs/packages/lexical-dragon.md
@@ -1,8 +1,6 @@
 ---
 title: ''
-sidebar_position: 15
 sidebar_label: '@lexical/dragon'
-cache_reset: 1
 ---
 
 {@import ../../../lexical-dragon/README.md}
diff --git a/packages/lexical-website/docs/packages/lexical-file.md b/packages/lexical-website/docs/packages/lexical-file.md
@@ -1,8 +1,6 @@
 ---
 title: ''
-sidebar_position: 15
 sidebar_label: '@lexical/file'
-cache_reset: 1
 ---
 
 {@import ../../../lexical-file/README.md}
diff --git a/packages/lexical-website/docs/packages/lexical-hashtag.md b/packages/lexical-website/docs/packages/lexical-hashtag.md
@@ -1,8 +1,6 @@
 ---
 title: ''
-sidebar_position: 14
 sidebar_label: '@lexical/hashtag'
-cache_reset: 1
 ---
 
 {@import ../../../lexical-hashtag/README.md}
diff --git a/packages/lexical-website/docs/packages/lexical-headless.md b/packages/lexical-website/docs/packages/lexical-headless.md
@@ -1,8 +1,6 @@
 ---
 title: ''
-sidebar_position: 16
 sidebar_label: '@lexical/headless'
-cache_reset: 1
 ---
 
 {@import ../../../lexical-headless/README.md}
diff --git a/packages/lexical-website/docs/packages/lexical-history.md b/packages/lexical-website/docs/packages/lexical-history.md
@@ -1,8 +1,6 @@
 ---
 title: ''
-sidebar_position: 8
 sidebar_label: '@lexical/history'
-cache_reset: 1
 ---
 
 {@import ../../../lexical-history/README.md}
diff --git a/packages/lexical-website/docs/packages/lexical-html.md b/packages/lexical-website/docs/packages/lexical-html.md
@@ -1,8 +1,6 @@
 ---
 title: ''
-sidebar_position: 4
 sidebar_label: '@lexical/html'
-cache_reset: 1
 ---
 
 {@import ../../../lexical-html/README.md}
diff --git a/packages/lexical-website/docs/packages/lexical-link.md b/packages/lexical-website/docs/packages/lexical-link.md
@@ -1,8 +1,6 @@
 ---
 title: ''
-sidebar_position: 15
 sidebar_label: '@lexical/link'
-cache_reset: 1
 ---
 
 {@import ../../../lexical-link/README.md}
diff --git a/packages/lexical-website/docs/packages/lexical-list.md b/packages/lexical-website/docs/packages/lexical-list.md
@@ -1,8 +1,6 @@
 ---
 title: ''
-sidebar_position: 9
 sidebar_label: '@lexical/list'
-cache_reset: 1
 ---
 
 {@import ../../../lexical-list/README.md}
diff --git a/packages/lexical-website/docs/packages/lexical-mark.md b/packages/lexical-website/docs/packages/lexical-mark.md
@@ -1,8 +1,6 @@
 ---
 title: ''
-sidebar_position: 4
 sidebar_label: '@lexical/mark'
-cache_reset: 1
 ---
 
 {@import ../../../lexical-mark/README.md}
diff --git a/packages/lexical-website/docs/packages/lexical-markdown.md b/packages/lexical-website/docs/packages/lexical-markdown.md
@@ -1,8 +1,6 @@
 ---
 title: ''
-sidebar_position: 11
 sidebar_label: '@lexical/markdown'
-cache_reset: 1
 ---
 
 {@import ../../../lexical-markdown/README.md}
diff --git a/packages/lexical-website/docs/packages/lexical-offset.md b/packages/lexical-website/docs/packages/lexical-offset.md
@@ -1,8 +1,6 @@
 ---
 title: ''
-sidebar_position: 12
 sidebar_label: '@lexical/offset'
-cache_reset: 1
 ---
 
 {@import ../../../lexical-offset/README.md}
diff --git a/packages/lexical-website/docs/packages/lexical-overflow.md b/packages/lexical-website/docs/packages/lexical-overflow.md
@@ -1,8 +1,6 @@
 ---
 title: ''
-sidebar_position: 4
 sidebar_label: '@lexical/overflow'
-cache_reset: 1
 ---
 
 {@import ../../../lexical-overflow/README.md}
diff --git a/packages/lexical-website/docs/packages/lexical-plain-text.md b/packages/lexical-website/docs/packages/lexical-plain-text.md
@@ -1,6 +1,5 @@
 ---
 title: ''
-sidebar_position: 2
 sidebar_label: '@lexical/plain-text'
 ---
 

diff --git a/packages/lexical-website/docs/packages/lexical-react.md b/packages/lexical-website/docs/packages/lexical-react.md
@@ -0,0 +1,6 @@
+---
+title: ''
+sidebar_label: '@lexical/react'
+---
+
+{@import ../../../lexical-react/README.md}
diff --git a/packages/lexical-website/docs/packages/lexical-rich-text.md b/packages/lexical-website/docs/packages/lexical-rich-text.md
@@ -1,6 +1,5 @@
 ---
 title: ''
-sidebar_position: 3
 sidebar_label: '@lexical/rich-text'
 ---
 

diff --git a/packages/lexical-website/docs/packages/lexical-selection.md b/packages/lexical-website/docs/packages/lexical-selection.md
@@ -1,8 +1,6 @@
 ---
 title: ''
-sidebar_position: 4
 sidebar_label: '@lexical/selection'
-cache_reset: 1
 ---
 
 {@import ../../../lexical-selection/README.md}
diff --git a/packages/lexical-website/docs/packages/lexical-table.md b/packages/lexical-website/docs/packages/lexical-table.md
@@ -1,8 +1,6 @@
 ---
 title: ''
-sidebar_position: 10
 sidebar_label: '@lexical/table'
-cache_reset: 1
 ---
 
 {@import ../../../lexical-table/README.md}
diff --git a/packages/lexical-website/docs/packages/lexical-text.md b/packages/lexical-website/docs/packages/lexical-text.md
@@ -1,8 +1,6 @@
 ---
 title: ''
-sidebar_position: 5
 sidebar_label: '@lexical/text'
-cache_reset: 1
 ---
 
 {@import ../../../lexical-text/README.md}
diff --git a/packages/lexical-website/docs/packages/lexical-utils.md b/packages/lexical-website/docs/packages/lexical-utils.md
@@ -1,8 +1,6 @@
 ---
 title: ''
-sidebar_position: 6
 sidebar_label: '@lexical/utils'
-cache_reset: 1
 ---
 
 {@import ../../../lexical-utils/README.md}
diff --git a/packages/lexical-website/docs/packages/lexical-yjs.md b/packages/lexical-website/docs/packages/lexical-yjs.md
@@ -0,0 +1,6 @@
+---
+title: ''
+sidebar_label: '@lexical/yjs'
+---
+
+{@import ../../../lexical-yjs/README.md}