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

Update usage documentation template #814

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

Not sure why we would update this template... aside from the removal of the Live Demo, this is the template that Jan put together and we haven't even finished migrating all of the Carbon React component usage tabs to it yet.

It'd be great to look at all of our content... but not sure why this would be a v1 thing.

mattrosno commented 2 years ago

@jeanservaas if it only needs a small removal of the Live Demo - that's great.

The schema has asset docs: https://github.com/carbon-design-system/carbon-platform/blob/main/docs/resource-schemas.md#asset-docs

In our contribution documentation, we need to let people know which markdown template to use where. For example, use this usage documentation template [link] for the markdown file used in the schema usagePath key.