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(fix): reorganized usage guide for new users #3325

Merged
merged 2 commits into from
Dec 9, 2018

Conversation

ebectar
Copy link
Contributor

@ebectar ebectar commented Dec 6, 2018

Reorganized the docs usage page to try to make the installation process more clear for beginner users.

@welcome
Copy link

welcome bot commented Dec 6, 2018

💖 Thanks for opening this pull request! 💖

Here is a list of things that will help get it across the finish line:

  • Run yarn lint locally to catch formatting errors. This will fix some errors automatically, commit and push any changes.
  • Run yarn test locally to catch errors. This ensures all components still behave as they should.
  • Run yarn start to run the doc site locally and try a few pages, ensuring everything is in good working order.
  • Include tests when adding/changing behavior.

We get a lot of pull requests on this repo, so please be patient and we will get back to you as soon as we can.

@codecov-io
Copy link

codecov-io commented Dec 9, 2018

Codecov Report

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

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #3325   +/-   ##
=======================================
  Coverage   99.89%   99.89%           
=======================================
  Files         170      170           
  Lines        2801     2801           
=======================================
  Hits         2798     2798           
  Misses          3        3
Impacted Files Coverage Δ
src/elements/Button/Button.js 100% <0%> (ø) ⬆️
src/modules/Dimmer/DimmerInner.js 100% <0%> (ø) ⬆️

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 132e73f...d3c6743. Read the comment docs.

@levithomason levithomason force-pushed the fix/usage branch 6 times, most recently from 48ce0c7 to a787e63 Compare December 9, 2018 22:44
@levithomason
Copy link
Member

Thanks for starting up this work! This page was getting quite cluttered and overwhelming.

I've reworked it a bit to use simplified language and tabs to clean it up:

image

@levithomason levithomason merged commit dd2e32a into Semantic-Org:master Dec 9, 2018
@welcome
Copy link

welcome bot commented Dec 9, 2018

Congrats on merging your first pull request! 🎉🎉🎉

robot victory dance

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants