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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Integrate documentation.js #37

Merged
merged 5 commits into from
Dec 9, 2016
Merged

Integrate documentation.js #37

merged 5 commits into from
Dec 9, 2016

Conversation

mxstbr
Copy link
Member

@mxstbr mxstbr commented Dec 8, 2016

This is so nice! Looks like a huge PR, but is actually much less code now since the theme is no longer inlined. I was able to remove almost all JSDoc comments (except for the examples) in favor of flow types, and documentation understood everything perfectly! 馃槺 So super cool!

This is what it looks like right now, which to be honest I quite like!

screen shot 2016-12-08 at 21 16 19

Whatcha think @bhough?

Ref: #31

@bhough
Copy link
Contributor

bhough commented Dec 9, 2016

@mxstbr this looks great! Looks like it will need #38 to pass CI, with that and conflict resolution let's merge it ASAP.

@codecov-io
Copy link

codecov-io commented Dec 9, 2016

Current coverage is 100% (diff: 100%)

Merging #37 into master will not change coverage

@@           master   #37   diff @@
===================================
  Files           7     7          
  Lines          12    12          
  Methods         0     0          
  Messages        0     0          
  Branches        0     0          
===================================
  Hits           12    12          
  Misses          0     0          
  Partials        0     0          

Powered by Codecov. Last update 9f2fb5b...dddae29

@mxstbr
Copy link
Member Author

mxstbr commented Dec 9, 2016

Let's 馃殺 this first thing @bhough! Can you review & merge?

Copy link
Contributor

@bhough bhough left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One small comment @mxstbr

@@ -55,6 +55,7 @@
"babel-preset-latest": "^6.16.0",
"cz-conventional-changelog": "^1.2.0",
"docdash": "^0.4.0",
"documentation": "^4.0.0-beta16",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we remove the JSDocs and associated Babel plugin as a dependency now?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Arg yes we should, good catch! Mind doing that and pushing to the branch?

Remove npm packages leftover from previous JSDocs implementation.
@bhough bhough merged commit 0672f78 into master Dec 9, 2016
@bhough bhough deleted the documentation-js branch December 9, 2016 23:45
@bhough bhough mentioned this pull request Dec 10, 2016
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.

None yet

3 participants