Skip to content

doc: update synopsis, toc, other nits#6167

Merged
Fishrock123 merged 3 commits intonodejs:masterfrom
Fishrock123:modernize-docs
Apr 29, 2016
Merged

doc: update synopsis, toc, other nits#6167
Fishrock123 merged 3 commits intonodejs:masterfrom
Fishrock123:modernize-docs

Conversation

@Fishrock123
Copy link
Copy Markdown
Contributor

@Fishrock123 Fishrock123 commented Apr 12, 2016

Checklist
  • tests and code linting passes
  • documentation is changed or added
  • the commit message follows commit guidelines
Affected core subsystem(s)

doc

Description of change

There are a few things here:

  • Updated the Example to be more modern and better reflect the example in https://nodejs.org/en/about/
  • Renamed Synopsis to Usage & Example
  • Node.js(1) in the TOC is now Node.js since the former does not make sense in any context
  • The TOC is now subdivided: general about, subsystems, extra links
  • Added a toc / sidebar link to the repo/issue tracker and also the mailing list

cc @nodejs/documentation

Loading
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Issues and PRs related to the documentations.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

9 participants