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.
This PR implements a redesign of our component documentation pages on .design worked on by me and @sooachung over Skunkworks in Oct 2023.
The PR introduces several new features including:
parameters
experimental
branch on Contentstack, which can be used in the future for similar blue-sky changes to .designAs presented in my Skunkworks demo, these are the visioned benefits of this change:
For maximization of the updates made here, I recommend updating our design guidelines on Contentstack to resemble the guidelines for TextInput on the
experimental
branch of our Contentstack instance. This is an example guideline that Sooa and I have created to demonstrate how powerful these new updates can be.Other changes that would help make the most of these features are:
experimental
branch tomain
on Contentstack.parameters
as demonstrated in this PRexperimental
branch tomain
on Contentstack.Not making the above changes and merging this in would still ensure the layout changes and breadcrumbs are added to our website. If I were around to help push this through, I would've gotten this PR reviewed, then applied the above changes, and then asked our users for thoughts on the new guidelines format proposed with the TextInput guidelines. IF feedback was positive, then similar changes could be made to other components moving forward. If the changes were applied, it would be best for engineers to get in the habit of contributing to guidelines as the goal of this initiative is to combine engineering docs with design docs.
--
The LiveExample content type on Contentstack works by identifying stories on Storybook by function name. For example, the
States Demo
story on Storybook is defined by the functionStatesDemo
in the Storybook file, and that's what should be populated in the LiveExample entry on Contentstack.--
Aspects of this PR I consider a little incomplete are:
This PR would also address the following tickets: