-
Notifications
You must be signed in to change notification settings - Fork 4.1k
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(usage): update usage page with import examples #1336
docs(usage): update usage page with import examples #1336
Conversation
I think I'd rather link to some of the existing examples to show how to use components. There are several advantages to doing this. The examples have automated tests to ensure they work, the code is editable, they are actively managed, and they are already done :) I also like the idea of directing the user on through the docs to learn more after setup. The examples have another cool feature. If you link directly to an example's anchor link, the page will load with the code editor open and show the rendered HTML: http://react.semantic-ui.com/elements/button#button Given this, let's update this section to inform the user that every example includes fully functional and editable code snippets. Then, let's link to 3 or 4 in a , using the basic button I used above as the first link. |
Codecov Report
@@ Coverage Diff @@
## master #1336 +/- ##
=======================================
Coverage 99.75% 99.75%
=======================================
Files 140 140
Lines 2402 2402
=======================================
Hits 2396 2396
Misses 6 6
Continue to review full report at Codecov.
|
@levithomason Okay, I've updated this PR with a simple UL containing some links to example components. Please let me know if this is what you had in mind. Cheers |
Thanks! |
* docs(usage): update usage page with import examples * Provide links to examples from Usage page * Correction for linter * refactor(Usage): update verbiage
* docs(usage): update usage page with import examples * Provide links to examples from Usage page * Correction for linter * refactor(Usage): update verbiage
Closes #1330.