Skip to content
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

Merged

Conversation

andrewhl
Copy link
Contributor

Closes #1330.

@levithomason
Copy link
Member

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

image

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-io
Copy link

codecov-io commented Feb 24, 2017

Codecov Report

Merging #1336 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #1336   +/-   ##
=======================================
  Coverage   99.75%   99.75%           
=======================================
  Files         140      140           
  Lines        2402     2402           
=======================================
  Hits         2396     2396           
  Misses          6        6
Impacted Files Coverage Δ
src/modules/Popup/Popup.js 100% <ø> (ø)
src/modules/Popup/PopupHeader.js 100% <ø> (ø)
src/modules/Popup/PopupContent.js 100% <ø> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 6f5a22e...d6a8e57. Read the comment docs.

@andrewhl
Copy link
Contributor Author

@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

@levithomason levithomason merged commit 96d469f into Semantic-Org:master Feb 26, 2017
@levithomason
Copy link
Member

Thanks!

@andrewhl andrewhl deleted the chore/update-usage-docs-with-example branch February 26, 2017 16:39
harel pushed a commit to harel/Semantic-UI-React that referenced this pull request Mar 8, 2017
* docs(usage): update usage page with import examples

* Provide links to examples from Usage page

* Correction for linter

* refactor(Usage): update verbiage
harel pushed a commit to harel/Semantic-UI-React that referenced this pull request Mar 8, 2017
* docs(usage): update usage page with import examples

* Provide links to examples from Usage page

* Correction for linter

* refactor(Usage): update verbiage
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants