docs(readme): add FAQ #1480
docs(readme): add FAQ #1480
Conversation
Codecov Report
@@ Coverage Diff @@
## master #1480 +/- ##
=======================================
Coverage 99.74% 99.74%
=======================================
Files 141 141
Lines 2371 2371
=======================================
Hits 2365 2365
Misses 6 6Continue to review full report at Codecov.
|
| @@ -301,7 +301,7 @@ A [`ui header`][5] accepts a size class. The `ui modal` has a *component part* | |||
|
|
|||
| #### React Components & Sub Components | |||
|
|
|||
| Top level Semantic-UI-React components correspond to SUI *components*. Stardust sub components correspond to SUI *component parts*. | |||
| Top level Semantic UI React components correspond to SUI *components*. Stardust sub components correspond to SUI *component parts*. | |||
There was a problem hiding this comment.
Standardized library name without hyphens.
|
|
||
| This is a listing of example projects and guides that will help you integrate Semantic-UI-React into your new or existing projects. | ||
| ## FAQ |
| @@ -61,11 +75,11 @@ These great products are built on Semantic-UI-React. Add yours [here][22]. | |||
| - http://www.brewhousesolutions.com | |||
| - https://www.lifebot.fr | |||
|
|
|||
| ## Voice Your Opinion :speech_balloon: | |||
| ## Voice Your Opinion | |||
There was a problem hiding this comment.
Some headers had emoji and others did not. Standardized README headers to not have any emoji.
| @@ -3,7 +3,7 @@ import { Card } from 'semantic-ui-react' | |||
|
|
|||
| const CardExampleLinkCard = () => ( | |||
| <Card | |||
| href='#link' | |||
| href='#card-example-link-card' | |||
There was a problem hiding this comment.
Fixed link to example to use new anchor links (name of examle file).
| <a href='http://react.semantic-ui.com/modules/modal#modal'>Modal</a> | ||
| </li> | ||
| <li> | ||
| <NavLink to='/elements/button#button-example-button'>Button</NavLink> |
There was a problem hiding this comment.
These were <a> tags which caused a full page reload. Replaced with react-router-dom nav links and fixed paths to point to new anchors.
This PR adds an FAQ section to the README. It also standardizes the library name to "Semantic UI React", without hyphens. Lastly, several internal links within the doc were fixed.