Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: fix typedoc links and add missing packages #5850

Merged
merged 1 commit into from
Apr 14, 2024

Conversation

etrepum
Copy link
Collaborator

@etrepum etrepum commented Apr 9, 2024

  • 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

Copy link

vercel bot commented Apr 9, 2024

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

Copy link
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
Contributor

StyleT commented Apr 10, 2024

I will give others opportunity to review and merge

@acywatson acywatson merged commit a951969 into facebook:main Apr 14, 2024
45 checks passed
@etrepum etrepum deleted the api-doc-link-fixes branch April 14, 2024 17:13
@acywatson acywatson mentioned this pull request Apr 16, 2024
@etrepum etrepum mentioned this pull request Apr 17, 2024
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.

4 participants