[EUI+] Split up several component pages into subpages #8181
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
- makes props tables significantly easier to grok + restore button cards at top of main button intro
cee-chen
added
documentation
+ add an aspirational guidelines page 🙏
cee-chen
force-pushed
the
website/reorg-1
branch
from
1342cb1
to
fa74f0a
Compare
+ add EuiSplitPanel props
- it's one of our most used (and sometimes most misused) components, so we might as well spend more time here - flex usage has also changed somewhat since the docs were first written (we use `gap` now instead of negative margins, and flex grid uses CSS grid instead of flexbox), so some of this copy needed updating
|
Preview staging links for this PR:
|
💚 Build Succeeded
History
|
weronikaolejniczak
approved these changes
Nov 25, 2024
There was a problem hiding this comment.
Amazing job! 🎉 Went through all the changes, didn't notice any issues or typos, also couldn't think of any other page that might need this reorg 🤔 I especially like the Button page division, it's much cleaner now, since ButtonEmpty, ButtonGroup and ButtonIcon are completely separate but their prop tables made the page quite long.
I'm leaving an approve but feel free to ping anybody else for a review in case you want additional feedback 😄
Btw I created a task for this under the meta issue: #8163
|
Thanks a million Weronika!! I feel good merging this in with just one review since it's a docs-only change, and we can keep improving/tweaking them over time. |
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.
Summary
The primary goal of this PR is making certain very long component doc pages more readable/dev-friendly, and also not have a million props tables in a row (EuiButton is the primary culprit of this).
If you have any other suggestions for components that would benefit from more subpages, feel free to throw them into this PR! (or we can open other follow up PRs!)
QA
Check that the following docs pages and their copy/examples/props table generally work and look sane:
General checklist
N/A, docs only