This repository has been archived by the owner on Mar 4, 2020. It is now read-only.
docs: simplify and update accessibility headings #387
Merged
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
levithomason
requested review from
dvdzkwsk,
kuzhelov,
miroslavstastny and
mnajdova
as code owners
Codecov Report
@@ Coverage Diff @@
## master #387 +/- ##
=======================================
Coverage 91.72% 91.72%
=======================================
Files 41 41
Lines 1341 1341
Branches 172 172
=======================================
Hits 1230 1230
Misses 107 107
Partials 4 4
Continue to review full report at Codecov.
|
hughreeling
approved these changes
Oct 23, 2018
levithomason
changed the title
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Doc Site
Here are some of the changes in this PR and the standards behind them.
Only render content helpful to our users. Hide UI elements when information is not available:
Render error messages that are meant for ourselves as library authors.
Write component descriptions that explain the purpose of a component in relation to the user and the UI:
Tip: Reference react.semantic-ui.comOnly render content helpful to our users.
Use public facing content for TODOs or other internal needs.
ComponentDocTag.tsx=>ComponentDocAccessibility.tsxThis component was complex and only handled displaying component accessibility. It has been refactored and renamed
ComponentDocAccessibilityto be a dedicated component accessibility display component.We should avoid premature abstraction in this way. It is easier to abstract something later than to work with an abstraction early on.