Rename Library.{Pattern, Example} => Library.{SectionL2, SectionL3}
#1818
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1818 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 70 70
Lines 1273 1273
Branches 478 478
=========================================
Hits 1273 1273 ☔ View full report in Codecov by Sentry. |
acelaya
approved these changes
Dec 3, 2024
Comment on lines
636
to
652
| Example, | ||
| SectionL3, | ||
| Info, | ||
| InfoItem, | ||
| Link, | ||
| Page, | ||
| Pattern, | ||
| SectionL2, | ||
| Section, |
There was a problem hiding this comment.
Maybe we should sort these.
The hierarchical relationship between `Library.{Section, Pattern, Example}` was
unclear and the `Pattern` and `Example` components had an unclear purpose since
they were used as sections with different kinds of content. Rename these
components to make the structure clearer: `Page` -> `Section` -> `SectionL2` ->
`SectionL3` where `SectionL{N}` is effectively an alias for `<Section
level={N}>`. In the process the meaning of the `level` prop has been adjusted
to match the logical section level.
In the process also correct the usage of the `<main>` element to refer to just
the main content of the page (ie. excluding navigation) instead of the whole
page.
robertknight
force-pushed
the
rename-library-sections
branch
from
630955f to
e94aef2
Compare
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.
The hierarchical relationship between
Library.{Section, Pattern, Example}was unclear and thePatternandExamplecomponents had an unclear purpose since they were used as sections with different kinds of content. Rename thesecomponents to make the structure clearer:
Page->Section->SectionL2->SectionL3whereSectionL{N}is effectively an alias for<Section level={N}>. In the process the meaning of thelevelprop has been adjusted to match the logical section level.In the process also correct the usage of the
<main>element to refer to just the main content of the page (ie. excluding navigation) instead of the whole page.Discussed here in Slack.