search

carbon-design-system / carbon-platform

The "next" version of the Carbon Design System website, as a platform.
https://next.carbondesignsystem.com
Apache License 2.0
21 stars 5 forks source link

Create style documentation template #816

Open mattrosno opened 2 years ago

mattrosno commented 2 years ago

Acceptance criteria

mattrosno commented 2 years ago

Hey team! Please add your planning poker estimate with ZenHub @aubrey-oneal @kingtraceyj

jeanservaas commented 2 years ago

Again... nice to have... this has been on the Systems board for like years. I definitely think we need it, but I don't think we need it for v1. I'd also say it's work we could leverage @aagonzales for if we want to do another away mission with her. She's the one who's had her eye on this as a potential project forever.

mattrosno commented 2 years ago

It seems like most all style pages have:

For example: https://carbondesignsystem.com/components/text-input/style

The asset.docs.stylePath schema key points to a markdown file (https://github.com/carbon-design-system/carbon-platform/blob/main/docs/resource-schemas.md#asset-docs). It would be nice to at minimum state that we want the Style pages to have those headings.

I think we could keep it simple with the style documentation template that reflects how the style pages are generally structured today, and we can update the template later if we want to change the structure to something better in the future.

mattrosno commented 2 years ago

If we don't have a style documentation template at all, that increases the likelihood of style pages deviating away from our current structure of: