Skip to content

docs: fix typedoc links and add missing packages#5850

Merged
acywatson merged 1 commit intofacebook:mainfrom
etrepum:api-doc-link-fixes
Apr 14, 2024
Merged

docs: fix typedoc links and add missing packages#5850
acywatson merged 1 commit intofacebook:mainfrom
etrepum:api-doc-link-fixes

Conversation

@etrepum
Copy link
Copy Markdown
Collaborator

@etrepum etrepum commented Apr 9, 2024 •
edited
Loading

  • Added lexical-typedoc-module-name plugin to determine the module name from the path
    • Removed @module from all index.ts files
    • Enabled header/header eslint rule everywhere
    • Fixed header/header lint mistakes from modules that formerly contained @module
  • Added lexical-remark-slugify-anchors plugin to fix typedoc-generated links to symbols that start with $ so that they work in docusaurus, and also fixes up the text so the links don't include the package scope, e.g. lexical/html!$generateHtmlFromNodes now displays as $generateHtmlFromNodes and should also link to the correct place
  • Added @lexical/react and @lexical-yjs package docs to the sidebar
  • Added entrypoints for @lexical/plain-text, @lexical/rich-text, @lexical/react to the typedoc config
  • Configures typedoc to generate github links to the main tree (it works by default locally, but wherever this is building doesn't have a proper git checkout with remote, so this will override it)
  • Removes unnecessary sidebar_position, cache_reset frontmatter from package docs
  • Fixed @link typo in LexicalNode typedoc comment
  • Fixed URL typo in @lexical/devtools-core package docs

@vercel
Copy link
Copy Markdown

vercel bot commented Apr 9, 2024 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
lexical ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 9, 2024 3:30am
lexical-playground ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 9, 2024 3:30am

@facebook-github-bot facebook-github-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 Apr 9, 2024
@etrepum etrepum force-pushed the api-doc-link-fixes branch from 3b14dd4 to b3421a2 Compare April 9, 2024 02:54
@etrepum etrepum force-pushed the api-doc-link-fixes branch from b3421a2 to 817d500 Compare April 9, 2024 03:01
@etrepum etrepum force-pushed the api-doc-link-fixes branch from 817d500 to a658409 Compare April 9, 2024 03:08
@etrepum etrepum force-pushed the api-doc-link-fixes branch from a658409 to 31be6fe Compare April 9, 2024 03:20
@etrepum etrepum force-pushed the api-doc-link-fixes branch from 31be6fe to f65bebb Compare April 9, 2024 03:28
@etrepum etrepum marked this pull request as ready for review April 9, 2024 03:39
@etrepum etrepum mentioned this pull request Apr 10, 2024
Open
@StyleT StyleT self-requested a review April 10, 2024 20:36
StyleT
StyleT approved these changes Apr 10, 2024
View reviewed changes
Copy link
Copy Markdown
Contributor

@StyleT StyleT left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@StyleT
Copy link
Copy Markdown
Contributor

StyleT commented Apr 10, 2024

I will give others opportunity to review and merge

@etrepum etrepum mentioned this pull request Apr 11, 2024
Merged
11 tasks
@acywatson acywatson merged commit a951969 into facebook:main Apr 14, 2024
@etrepum etrepum deleted the api-doc-link-fixes branch April 14, 2024 17:13
@acywatson acywatson mentioned this pull request Apr 16, 2024
Merged
@etrepum etrepum mentioned this pull request Apr 17, 2024
Closed
@dmitrymarokhonov dmitrymarokhonov mentioned this pull request May 19, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@StyleT StyleT StyleT approved these changes

@acywatson acywatson acywatson approved these changes

@zurfyx zurfyx Awaiting requested review from zurfyx zurfyx is a code owner

@fantactuka fantactuka Awaiting requested review from fantactuka fantactuka is a code owner

@Fetz Fetz Awaiting requested review from Fetz

@ivailop7 ivailop7 Awaiting requested review from ivailop7 ivailop7 is a code owner

Assignees

No one assigned

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

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@etrepum @StyleT @acywatson @facebook-github-bot