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(vuepress): add docs website #7

Draft
wants to merge 46 commits into
base: master
Choose a base branch
from
Draft

docs(vuepress): add docs website #7

wants to merge 46 commits into from

Conversation

dsseng
Copy link
Member

@dsseng dsseng commented Aug 11, 2019

TODO:

  • Set Vuepress up
  • Create base files
  • Acquire a domain: https://onyxjs.github.io/onyx
  • Make website deployable
  • Create base files for 🇷🇺 translation
  • Add lint
  • Document @onyxjs/matchers
    • Matchers root page
    • All the matchers
      • toBe
      • toBeDefined
      • toBeFalse
      • toBeInstanceOf
      • toBeNaN
      • toBeNull
      • toBeTrue
      • toBeTypeOf
      • toBeUndefined
      • toContain
      • toEqual
      • toHaveLength
      • toStrictlyEqual
      • toThrow
    • expect
    • Usage examples
    • Translations
      • 🇷🇺
      • ...
  • Document @onyxjs/mock
    • mock
    • spy
    • watch
    • Usage examples
    • Translations
      • 🇷🇺
      • ...

@dsseng dsseng added documentation Improvements or additions to documentation help wanted Extra attention is needed work in progress A work in progress labels Aug 11, 2019
@dsseng dsseng requested a review from ElijahKotyluk August 11, 2019 19:03
@codecov
Copy link

codecov bot commented Aug 11, 2019

Codecov Report

Merging #7 into master will increase coverage by 1.27%.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff            @@
##           master     #7      +/-   ##
========================================
+ Coverage   98.72%   100%   +1.27%     
========================================
  Files          24     18       -6     
  Lines         236     79     -157     
  Branches       45     15      -30     
========================================
- Hits          233     79     -154     
+ Misses          3      0       -3
Impacted Files Coverage Δ
packages/matchers/src/expect.ts 100% <0%> (ø) ⬆️
packages/mock/src/mock.ts 100% <0%> (ø) ⬆️
packages/matchers/src/toThrow.ts 100% <0%> (ø) ⬆️
packages/core/src/result.ts
packages/mock/src/mockMatchers.ts
packages/matchers/src/matchers.ts
packages/core/src/suite.ts
packages/core/src/interface.ts
packages/core/src/runnable.ts

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 3d749a4...5d1b5f1. Read the comment docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed work in progress A work in progress
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants