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

Improve addons-docs blocks documentation #14244

Closed
Sm1t opened this issue Mar 16, 2021 · 2 comments
Closed

Improve addons-docs blocks documentation #14244

Sm1t opened this issue Mar 16, 2021 · 2 comments

Comments

@Sm1t
Copy link

Sm1t commented Mar 16, 2021

Is your feature request related to a problem? Please describe
I was inspired by the color documentation in the design system, and wanted to do something similar in my project, but could not find documentation about Color, ColorPalette, etc. (of course, I found what I was looking for after diving into the repository)

Describe the solution you'd like
I think it will be useful to add information about all components of addons-docs/blocks to the official documentation. This can be a simple table with a list of components and a short description, or even better, detailed documentation of the components, including examples.

Describe alternatives you've considered
We can also add a description for blocks directly to the addons-docs readme.md, and link to this description from the official documentation.

Are you able to assist to bring the feature to reality?
Yes, I agree to write the documentation as you see it

@Sm1t
Copy link
Author

Sm1t commented Mar 19, 2021

@jonniebigodes hi, what do you think about it?

@jonniebigodes
Copy link
Contributor

With the recent pull request that was just merged the documentation was updated to include additional information and examples about the Docs blocks.

Feel free to raise any additional issues and let me know about improvements to the existing documentation. Would love to hear everyone's thoughts.

Thanks for raising this and sorry for the delayed response.

Hope all of you have a great day and stay safe

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants