adobe / spectrum-css

The standard CSS implementation of the Spectrum design language.
http://opensource.adobe.com/spectrum-css/
Apache License 2.0
1.18k stars 195 forks source link

docs(typography): docs site to storybook #3074

Open rise-erpelding opened 1 week ago

rise-erpelding commented 1 week ago

Description

This PR continues with migrating the documentation of components from the old docs site to Storybook, migrating content from all docs site typography pages, including the typography base page, internationalized typography page, typography body page, typography code page, typography detail page, and typography heading page. Existing docs page stories (those with the !dev tag) have been updated/renamed or added to include more variants and sizing.

If it's helpful, here's a general summary of how the docs site Typography pages are organized, and where this is located in the Typography Storybook Docs page: Docs Site Storybook
Typography general page (/typography.html): Variants for Heading, Body, Detail, Code Replaced by Default story showing all Typography components
Typography general page (/typography.html): section on applying margins Added to description of Default story
Typography general page (/typography.html): section on migrating from deprecated typography These changes are ~4 years old so they've been eliminated from the Storybook Docs, but I've moved them to the Changelog for now, happy to hear any opinions that this is unnecessary--I can easily drop this change!
Typography heading page (/typography-heading.html): Variants, Heavy, and Light sections All displayed in the two stories for heading variants and heading sizes in the Heading section
Typography heading page (/typography-heading.html): Typography section showing content hierarchies Displayed in Heading vs. Body Hierarchy section below the Body stories
Typography body page (/typography-body.html): Variants section All displayed in the two stories for body variants and body sizes in the Body section
Typography body page (/typography-body.html): Standard section showing content hierarchies Eliminated/already displayed in Heading vs. Body Hierarchy section below the Body stories
Typography detail page (/typography-detail.html): Variants All displayed in the two stories for detail variants and detail sizes in the Detail section
Typography code page (/typography-code.html): Variants All displayed in the two stories for code variants and code sizes in the Code section, note that the template doesn't support code wrapped in <pre> tags, so this is no longer demonstrated (it's not a special feature of the implementation however) but is noted in the story description
Internationalized typography page (/typography-international.html): Variants for heading, heavy heading, and light heading Contained in Internationalized Heading sub-section in Internationalized Typography section - sizing has been eliminated
Internationalized typography page (/typography-international.html): Variants for body Contained in Internationalized Body sub-section in Internationalized Typography section - sizing has been eliminated
Internationalized typography page (/typography-international.html): Variants for detail Contained in Internationalized Detail sub-section in Internationalized Typography section - sizing has been eliminated
Internationalized typography page (/typography-international.html): Variants for Han Contained in Internationalized Heading vs. Body Hierarchy sub-section in Internationalized Typography section, below Internationalized Body sub-section
Internationalized typography page (/typography-international.html): Variants for code Contained in Internationalized Code sub-section in Internationalized Typography section - sizing and code wrapped with <pre> tags have been eliminated

These changes are documentation only, so no changeset is needed. Also, no changes have been made to the typography Template.

CSS-794

How and where has this been tested?

Please tag yourself on the tests you've marked complete to confirm the tests have been run by someone other than the author.

Validation steps

Regression testing

Validate:

  1. The documentation pages for at least two other components are still loading, including:
  1. If components have been modified, VRTs have been run on this branch:

To-do list

changeset-bot[bot] commented 1 week ago

⚠️ No Changeset found

Latest commit: b962bf9f4ade3a6113c07a047ecdaf0addc11608

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

github-actions[bot] commented 1 week ago

File metrics

Summary

Total size: 4.10 MB*

🎉 No changes detected in any packages

github-actions[bot] commented 1 week ago

🚀 Deployed on https://pr-3074--spectrum-css.netlify.app