garage-week/storybook enhancements for future docs site #5916
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* chore: two ways of working with markdown files for guides * chore: cursor rule for migrating markdown to mdx if needed * chore: stubbed docs and ordered them * chore: lint fix
|
Contributor
📚 Branch Preview Links🔍 First Generation Visual Regression Test ResultsWhen a visual regression test fails (or has previously failed while working on this branch), its results can be found in the following URLs:
Deployed to Azure Blob Storage: If the changes are expected, update the |
* docs(a11y): added a11y guides to storybook * docs(a11y): fixed typo
* chore: two doc blocks to get custom docs added to the template * chore: clean upa few things * chore: usage stories and descriptions for custom doc blocks * chore: streamlining tags in stories and created capitalize utility * chore: review fixes * chore: updated tags in stories to new pattern
* docs(progress-circle): updated and formatted progress circle dpcs * docs(divider): updated and formatted divider stories * docs(divider): added size args to stories * docs(status-ligt): updated status-light docs and stories * docs(progress-circle): added progress arg type for docs and stories * docs(divider): added description to stories and docs * docs(badge): added description to stories and docs * docs(status-light): made correction to docs * docs(status-light): made correction to docs * docs(badge): updated badge docs and stories * docs: fixed typos * docs: removed the 'usage' tag from stories * docs(assets): updates asset docs and stories
* docs(contributor-guides): mrigrated contributor guides * docs(contributor-docs): updated contributor docs to reflect storybook migration * docs(contributor-guides): updated based on new IA and use of storybook * docs(contributor-guides): fixed MDX errors * docs(contributor-guides): fixed TOC * docs(contributor-guides): fixed typo * docs(contributor-guides): fixed TOC * docs(project-planning): migrated project-planning docs to storybook * docs(project-planning): fixed typo * docs(guides): fixed links
* chore: two doc blocks to get custom docs added to the template * chore: clean upa few things * chore: usage stories and descriptions for custom doc blocks * chore: streamlining tags in stories and created capitalize utility * chore: review fixes * chore: updated tags in stories to new pattern * chore: styling sturf and starting decorators * chore: all kinds of improvements * chore: working on static primary story but got smart links working * chore: clean up format and doc blocks * chore: migrated all 2nd gen to new format, made rules, working on styles * chore: removed tag from testing * chore: remove console logs * docs: updates rules for stories to include sections in the prescribed order * docs: updated rules to remove "demo" class recommendations for headings * docs: update exclusions for TOC headings in previews * docs: added rule to require that all stories are accessible * docs: status-light updates stories based on revised rules * docs: added additional styling parameters to flex layout decorator * docs: updated preview for better source code in docs * docs(status-light): updated status light based on new rules * docs(badge): updated docs according to updated rules * docs: updated flex-layout decorator for addtional styling options * docs: added a static colors decorator that displays both satic colors as a single story * docs: added a static colors decorator that displays both satic colors as a single story * docs: update rules to include static colors decorator * docs(divider): updated divider based on updated rules * docs: added a simple static colors exmaple to rules * docs(progress-circle): updated progress circle docs according to updated rules * docs(divider): simplified static colors story for divder and updated rules --------- Co-authored-by: Casey Eickhoff <ceickhoff@adobe.com>
* docs: updated flex-layout decorator to opt-in * docs: updating stories * docs: updated stories and section order * docs: updated rules * docs: updated contributor docs for migrating stories * docs: updated documentation * docs: updated documentation * Merge branch 'garage-week/docs-rocks' of github.com:adobe/spectrum-web-components into nikkimk/docs-rocks-refinements * docs: updated docs and rules to include picsum photos * docs: removed static-color-wrapper helper * docs: fixed sorting of getting started docs
* docs: updated about SWC with Kari's edits * docs: renamed get-started to about-swc * docs: fixed table import * docs: added documentation styl guide to style guides
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
@nikkimk, @KBmyer and I are taking a stab at bringing our 2nd-gen docs and IA to the future