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

Feature: [lexical-website] Upgrade docusaurus-plugin-typedoc and typedoc-plugin-markdown #6072

Open
etrepum opened this issue May 9, 2024 · 1 comment
Labels
contribution-week Issues that are good to be picked up for the contribution week enhancement Improvement over existing feature good first issue Good for newcomers

Comments

@etrepum
Copy link
Contributor

etrepum commented May 9, 2024

It seems that a lot of improvements have happened to docusaurus-plugin-typedoc, seems to fix some issues that I've noticed with how the docs are generated and organized, but it's a backwards incompatible change.

We should:

  • Upgrade these packages
  • Update the configuration accordingly (sidebars in particular, but we may also be able to get rid of some of our other plugins that exist just to work around previous bugs)
  • Update all of the static links to the documentation in the monorepo (the URL structure changes, but we also only have these references in the README files so it's not a big task)
  • Consider adding redirect routes in lexical-website so that old links redirect to their new location rather than 404
@etrepum etrepum added the enhancement Improvement over existing feature label May 9, 2024
@StyleT StyleT added good first issue Good for newcomers contribution-week Issues that are good to be picked up for the contribution week labels May 10, 2024
@TropicolX
Copy link

Hi @etrepum! Can I be assigned to work on this problem?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contribution-week Issues that are good to be picked up for the contribution week enhancement Improvement over existing feature good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants