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: generate packages sidebar from filesystem & group @lexical/react #5931

Merged
merged 2 commits into from
Apr 21, 2024

Conversation

etrepum
Copy link
Collaborator

@etrepum etrepum commented Apr 20, 2024

  • Generate the packages list from the filesystem (the collection of docs from README.md files)
  • Group generated API modules from the @lexical/react package into a sidebar category of their own

Compare:

It took a few tries to get this right, but as far as I can tell it matches the expected output now without any unintended changes to the sidebar order or label names.

Something to explore as a separate docs follow-up would be to adjust the font size of the titles on the module pages. Since we are using fully qualified module names, a lot of them wrap at 3rem. That's an easy one for someone else :)

RE #5869 this helps fix up one of the many places that manual configuration is used, and can be done independently from #5876 since this is isolated to lexical-website.

Resolves #5916
Resolves #5913

Copy link

vercel bot commented Apr 20, 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 20, 2024 11:40pm
lexical-playground ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 20, 2024 11:40pm

@ivailop7 ivailop7 merged commit 8b893c8 into facebook:main Apr 21, 2024
45 checks passed
@etrepum etrepum deleted the docs-sidebars-gh-5916 branch April 21, 2024 23:35
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.

Docs: Generate docusaurus sidebars from filesystem Bug: API modules list
3 participants