doc: split doc for different tools

[joyeecheung]

Split the docs for different tools to make the README more concise.

[joyeecheung]

Anyone wants to review it? Thanks! @nodejs/automation

[codecov[bot]]

Codecov Report

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

@@          Coverage Diff           @@
##           master    #162   +/-   ##
======================================
  Coverage    94.5%   94.5%           
======================================
  Files          16      16           
  Lines         600     600           
======================================
  Hits          567     567           
  Misses         33      33

---

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 226f45f...b64c496. Read the comment docs.

[targos]

but should we rename doc directory to docs?

+1. This would allow us to enable github pages for the docs directory

[joyeecheung]

@cPhost Node core is using doc, so I figured why not..

[joyeecheung]

Updated and merged. Thanks!

[priyank-p]

@cPhost Node core is using doc, so I figured why not..

Oh, i never noticed that. Normally all project stick to docs since all docs are in that place, so it makes sense to name it docs rather than doc.

[targos]

I was wrong about "docs" for gh pages. It only works if there is an index page. Instead I enabled it on master: https://nodejs.github.io/node-core-utils/

[priyank-p]

@targos i think if you would have enabled it as master branch /docs folder and visited the name of the https://nodejs.github.io/node-core-utils/get-metadata.html it should work.

[targos]

@cPhost Yeah, I initially tried that, but then there is no index page and since the README is automatically used as an index page, I think it's simpler to just enable master branch.

[priyank-p]

Yeah, thats true