[lexical-website] Breaking change: Upgrading docusaurus-plugin-typedoc

[inhwaS]

Description

This pull request addresses issue #6072 by updating the version of docusaurus-plugin-typedoc.
I refered this change log. Since it includes relevant modules, additional updates are required in other modules as well.

Changes Made

• docusaurus-plugin-typedoc version changed from 0.22.0 -> 1.0.5
• typedoc version changed from 0.25.12 -> 0.26.10
• typedoc-plugin-frontmatter plugin is added in docusaurus.config.js

Test plan

Before

Documents under ./packages/lexical-website/docs/api and ./packages/lexical-website/docs/packages are generated successfully.

After

Delete ./packages/lexical-website/docs/api and ./packages/lexical-website/docs/packages folders and run

npm run build

under lexical-website folder to confirm the documents are successfully generated.

Issue still need to be fixed

There’s an issue with updating below.

lexical/packages/lexical-website/sidebars.js

Lines 23 to 25 in e96ee55

	/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
	const sidebars = {
	api: [{dirName: 'api', type: 'autogenerated'}],

When I

• delete./packages/lexical-website/docs/api
• go to ./packages/lexical-website folder
• run command npm run build

the files are not automatically regenerated.
I documented this problem on the #6072 page, but I haven’t been able to resolve it since I’m unsure who is responsible for it.

I also reached out to the typedoc-plugin-markdown module repository for help with modifying the code here, but I’m not certain how to implement a fix.

Any assistance with this would be greatly appreciated.

[vercel]

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

Name	Status	Preview	Comments	Updated (UTC)
lexical	❌ Failed (Inspect)			Oct 30, 2024 6:27pm
lexical-playground	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 30, 2024 6:27pm

[facebook-github-bot]

Hi @inhwaS!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at [email protected]. Thanks!

[github-actions]

size-limit report 📦

Path	Size
lexical - cjs	29.94 KB (0%)
lexical - esm	29.78 KB (0%)
@lexical/rich-text - cjs	38.59 KB (0%)
@lexical/rich-text - esm	31.65 KB (0%)
@lexical/plain-text - cjs	37.25 KB (0%)
@lexical/plain-text - esm	28.94 KB (0%)
@lexical/react - cjs	40.32 KB (0%)
@lexical/react - esm	33.01 KB (0%)

[facebook-github-bot]

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

[etrepum]

It seems that there is an issue building the website with this change. Unfortunately I don't have permissions to see what the Vercel build error is.

[etrepum]

The docusaurus plugin was updated in #6761 which may affect this (at least it appears to have a conflict in package.json)

[potatowagon]

the error is

Build Failed
Command "npm run build" exited with 1

logs:

https://docs.google.com/document/d/13Gt5iz17SGlUE3Pm9387P3eDxX5hWm9vdSg6HP-UEyo/edit?usp=sharing