fix(docs): minor UX Writing Guide copy to match Dev Center IA conventions #1334
Conversation
This file contains 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
chanceaclark
previously approved these changes
Jan 23, 2024
|
converted to draft and do not merge label added -- merge or close pending review and approval from @bigcommerce/product-design. cc @bc-ghough. |
|
Product Design has had a team sync (1/24) on this PR and want to reiterate that this guide is for apps, integrations and our control panel. It should not reflect the writing rules for the dev documentation. We also discussed the term "Content guide" and decided the section name should be reverted back to "UX Writing Guide as 'UX Writing' is very different than 'Content Guide' |
slsriehl
changed the title
slsriehl
commented
Jan 30, 2024
slsriehl
commented
Jan 30, 2024
slsriehl
commented
Jan 30, 2024
|
Do not merge without approval from @bc-ghough |
bc-ghough
approved these changes
Jan 30, 2024
markcmurphy
approved these changes
Jan 31, 2024
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.
What?
Describe what changes you are making. e.g.
Adds X prop in the Box component.Why?
Please provide the reason(s) why you are making this change? Please no one-liners like,
It was missing.; expand upon the reason like,Adds X prop because it was missing in the Box component. Documentation notes this prop exists, but it actually wasn't implemented.Screenshots/Screen Recordings
This is a component library so we love visually looking at changes! If this applies to your pull request, show us your hard work in action.
Testing/Proof
Explain how you tested your new feature or bugfix. Please refrain from one-liners like,
Added tests.; expand upon how you tested your changes like,Added local tests to the new component and ensured test coverage was met. Manually tested on Safari@x.x.x..ping @bc-ghough @davelinke