carbon icon indicating copy to clipboard operation
carbon copied to clipboard

docs: update styles and react indexed descriptions

Open mattrosno opened this issue 1 year ago • 2 comments

Closes https://github.com/carbon-design-system/carbon-platform/issues/1054

References https://github.com/carbon-design-system/carbon-platform/issues/1109

This PR removes indexed component code documentation where code tabs are no longer needed. It also cleans up the Carbon config file formatting and order, as well as removes "unstable" from some ids and SVG names.

Changelog

New

  • UI shell left panel and UI shell right panel Carbon React assets, so the three UI shell components in that library can get the code tabs that have Codesandbox embeds of the React components. This means the three UI shell asset documentation pages in the React library should get Usage and Style from Carbon Styles because of inheritance, and Code tab from the Carbon React library.

Changed

  • Carbon Styles and Carbon React indexed descriptions per new design spec
  • Formatting of the Carbon React carbon.yml to clean up white space in the file
  • Alphabetized the assets in the Carbon Styles and Carbon React carbon.ymls so they are easier to audit
  • Renamed the ids and thumbnail SVG names so they no longer have "unstable" in them, as "unstable" designation isn't permanent like identifiers

Removed

  • codePath from indexed assets that no longer need a code tab. If the code tab previously just had links to other frameworks and live demos, since those are now shown in the asset overview tab, this PR removes the code tab from the index so the platform's asset detail pages no longer includes an empty code tab (page).

Testing / Reviewing

I didn't test these changes. If testing is necessary, to determine that the formatting didn't break anything, a developer from the Platform Squad can test against this PR's branch in a local environment.

mattrosno avatar Aug 08 '22 20:08 mattrosno

Deploy Preview for carbon-components-react ready!

Name Link
Latest commit 6f60a0f04bfefa1e533bea5b5b55020ea85e7f8d
Latest deploy log https://app.netlify.com/sites/carbon-components-react/deploys/62fa6e3bb8c88a000984b8d3
Deploy Preview https://deploy-preview-11931--carbon-components-react.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

netlify[bot] avatar Aug 08 '22 20:08 netlify[bot]

Deploy Preview for carbon-elements ready!

Name Link
Latest commit 6f60a0f04bfefa1e533bea5b5b55020ea85e7f8d
Latest deploy log https://app.netlify.com/sites/carbon-elements/deploys/62fa6e3bfbadac0008a163c1
Deploy Preview https://deploy-preview-11931--carbon-elements.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

netlify[bot] avatar Aug 08 '22 20:08 netlify[bot]

@carbon-design-system/carbon-platform-devs can you review?

mattrosno avatar Aug 11 '22 20:08 mattrosno

@tay1orjones not sure why Percy and the AVT CI failed when this PR only changes carbon.yml files, and a few SVGs referenced in those files.

mattrosno avatar Aug 15 '22 17:08 mattrosno