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

Documentation: TableOfContents editor component #62385

Conversation

colorful-tones
Copy link
Member

What? & Why?

Addresses one item in #60358

Adding documentation to existing editor components can help with any of the following:

  • encourages knowledge sharing and quicker onboarding for future devs
  • supports maintenance and troubleshooting
  • mitigates risk

How?

Add a JSDoc comment to the TableOfContents component and run npm run docs:build to populate the README with the newly added documents.

@colorful-tones colorful-tones merged commit be0f7f7 into WordPress:trunk Jun 7, 2024
63 of 64 checks passed
@github-actions github-actions bot added this to the Gutenberg 18.6 milestone Jun 7, 2024
patil-vipul pushed a commit to patil-vipul/gutenberg that referenced this pull request Jun 17, 2024
* Add JSDoc block for TableOfContents editor component

* Auto-generate editor docs for TableOfContents
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants