-
Notifications
You must be signed in to change notification settings - Fork 200
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs(button,icon): remove MDX files #3636
docs(button,icon): remove MDX files #3636
Conversation
|
File metricsSummaryTotal size: 2.24 MB* 🎉 No changes detected in any packages * Size is the sum of all main files for packages in the library.* An ASCII character in UTF-8 is 8 bits or 1 byte. |
🚀 Deployed on https://pr-3636--spectrum-css.netlify.app |
34edcc7
to
d239ea4
Compare
@@ -18,7 +18,7 @@ import { | |||
import { TypographyGroup } from "./typography.test.js"; | |||
|
|||
/** | |||
* Spectrum typography is broken out into several separate components: heading, body, detail, and code. Internationalized typography examples are also shown. | |||
* Spectrum typography is broken out into several separate components: [heading](#heading), [body](#body), [detail](#detail), and [code](#code). [Internationalized typography examples](#internationalized-typography) are also shown. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Typography is the only component where I have pretty strong feelings that we should keep the MDX file. To me, the organization of the MDX file better suits these docs, as opposed to just alphabetically listing everything. We can absolutely move all of the documentation into the stories file, it's totally possible, and I don't think we're losing any of the docs.
However, I think the current flow of the information on prod regarding the typography component seems more accessible and understandable to a user. It makes more sense to me.
Is that just my personal preference? Thoughts on reverting the typography changes and keeping the MDX file?
|
||
// ====== Docs: Internationalization ====== // | ||
/** | ||
* We should note that Hebrew and Arabic are rtl languages somewhere over here. | ||
* In the examples below, Hebrew and Arabic are "RTL" languages, meaning they are read from right to left. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This felt like a todo
that we missed and it ended up getting published! 😆 Any suggestions on what we want to say here instead?
b4afada
to
9fe59f2
Compare
9fe59f2
to
a0f14e9
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks good to me. I just had one minor suggestion for one of the story titles.
a0f14e9
to
f982d4c
Compare
f982d4c
to
e83e1f4
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great! Thanks for all of the extra little touches you added in; while we can't control the story order as well on a docs page, I think the organization is better overall in this new version!
- delete mdx file in favor of all docs being in stories file - update some story names to follow sentence-casing and organize like- stories together * docs(icon): remove MDX file - delete mdx file in favor of all docs being in stories file - update some story names to follow sentence-casing and organize like- stories together - move some markup into template file instead of stories file * docs(typography): add docs for rtl notes
e83e1f4
to
2870bc9
Compare
Description
This is the final installment in child PRs for CSS-986, where we are removing any unnecessary MDX documentation files. This PR migrates any documentation from MDX files to the component's
*.stories.js
file. No loss of documentation should have occurred, but minor changes, like correcting story names to organize similar stories together or reorganizing content now that there is not an MDX file or fixing sentence-casing, is acceptable. The components affected in this PR include button, icon, and typography. For each component, we have:icon
, moved any markup related templates into thetemplate.js
file (which then makes it consistent with all other components)No changeset is required for any of the components since no CSS is changed. VRT is unnecessary.
Jira/Specs
CSS-1051
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
typography (and this PR link to compare to typography's production)Regression testing
Validate:
Screenshots
To-do list