feat(docs): Switch to JSDOC docs not in the readme (#1383)

- Improve a few docs here and there - Rename the repo - Remove the authors field in the package.json
serialport · Nov 1, 2017 · 60fc047 · 60fc047
1 parent 22a36b1
commit 60fc047
Show file tree

Hide file tree

Showing 25 changed files with 244 additions and 1,468 deletions.
diff --git a/.doclets.yml b/.doclets.yml
@@ -0,0 +1,7 @@
+dir: lib
+packageJson: package.json
+articles:
+ 	- Overview: README.md
+branches:
+  - master
+  - jsdoc
diff --git a/.docs/README.hbs b/.docs/README.hbs
diff --git a/.docs/edit-warning.hbs b/.docs/edit-warning.hbs
diff --git a/.docs/sig-link.hbs b/.docs/sig-link.hbs
diff --git a/.docs/sig-name.hbs b/.docs/sig-name.hbs
diff --git a/.gitignore b/.gitignore
@@ -7,3 +7,4 @@ npm-debug.log
 package-lock.json
 Release/
 prebuilds/
+docs
diff --git a/.jsdoc.json b/.jsdoc.json
@@ -0,0 +1,34 @@
+{
+  "tags": {
+    "allowUnknownTags": true,
+    "dictionaries": ["jsdoc"]
+  },
+  "source": {
+    "include": ["lib", "README.md"],
+    "includePattern": ".+\\.(js|jsx)?$"
+  },
+  "plugins": [
+    "plugins/markdown"
+  ],
+  "markdown": {
+		"parser": "gfm",
+		"hardwrap": true,
+		"excludeTags": []
+	},
+  "templates": {
+    "cleverLinks": true,
+    "monospaceLinks": true
+  },
+  "opts": {
+    "template": "node_modules/docdash",
+    "encoding": "utf8",
+    "private": true,
+    "destination": "./docs/",
+    "recurse": true,
+    "_tutorials": "./examples"
+  },
+  "docdash": {
+    "static": true,
+    "sort": true
+  }
+}
diff --git a/.npmignore b/.npmignore
@@ -27,3 +27,4 @@ node_modules
 npm-debug.log
 package-lock.json
 Release/
+docs
diff --git a/.travis.yml b/.travis.yml
@@ -91,7 +91,6 @@ script:
     npm run lint
   fi;
 
-- npm run docs:diff
 - node ./
 - npm test
 

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,53 +1,53 @@
 <a name="6.0.4"></a>
-## [6.0.4](https://github.com/EmergingTechnologyAdvisors/node-serialport/compare/v6.0.3...v6.0.4) (2017-10-26)
+## [6.0.4](https://github.com/node-serialport/node-serialport/compare/v6.0.3...v6.0.4) (2017-10-26)
 
 
 ### Bug Fixes
 
-* **packages:** just-extend isn't necessary anymore ([#1376](https://github.com/EmergingTechnologyAdvisors/node-serialport/issues/1376)) ([8f650c3](https://github.com/EmergingTechnologyAdvisors/node-serialport/commit/8f650c3))
-* **windows:** bad parameter for ReadThread (windows) ([#1377](https://github.com/EmergingTechnologyAdvisors/node-serialport/issues/1377)) ([6f3afbe](https://github.com/EmergingTechnologyAdvisors/node-serialport/commit/6f3afbe))
+* **packages:** just-extend isn't necessary anymore ([#1376](https://github.com/node-serialport/node-serialport/issues/1376)) ([8f650c3](https://github.com/node-serialport/node-serialport/commit/8f650c3))
+* **windows:** bad parameter for ReadThread (windows) ([#1377](https://github.com/node-serialport/node-serialport/issues/1377)) ([6f3afbe](https://github.com/node-serialport/node-serialport/commit/6f3afbe))
 
 
 
 <a name="6.0.3"></a>
-## [6.0.3](https://github.com/EmergingTechnologyAdvisors/node-serialport/compare/v6.0.0...v6.0.3) (2017-10-22)
+## [6.0.3](https://github.com/node-serialport/node-serialport/compare/v6.0.0...v6.0.3) (2017-10-22)
 
 ### Bug Fixes
 
-* **windows:** Fix async handle leak ([#1367](https://github.com/EmergingTechnologyAdvisors/node-serialport/issues/1367)) ([c1d9d88](https://github.com/EmergingTechnologyAdvisors/node-serialport/commit/c1d9d88)), closes [#1363](https://github.com/EmergingTechnologyAdvisors/node-serialport/issues/1363)
-* **windows:** Fix read & write bugs for windows ([#1364](https://github.com/EmergingTechnologyAdvisors/node-serialport/issues/1364)) ([0e4b1f9](https://github.com/EmergingTechnologyAdvisors/node-serialport/commit/0e4b1f9))
+* **windows:** Fix async handle leak ([#1367](https://github.com/node-serialport/node-serialport/issues/1367)) ([c1d9d88](https://github.com/node-serialport/node-serialport/commit/c1d9d88)), closes [#1363](https://github.com/node-serialport/node-serialport/issues/1363)
+* **windows:** Fix read & write bugs for windows ([#1364](https://github.com/node-serialport/node-serialport/issues/1364)) ([0e4b1f9](https://github.com/node-serialport/node-serialport/commit/0e4b1f9))
 
 
 
 <a name="6.0.0"></a>
-# [6.0.0](https://github.com/EmergingTechnologyAdvisors/node-serialport/compare/5.0.0...v6.0.0) (2017-10-09)
+# [6.0.0](https://github.com/node-serialport/node-serialport/compare/5.0.0...v6.0.0) (2017-10-09)
 
 
 ### Features
 
-* **open:** Throw on incorrect baudrate option ([#1347](https://github.com/EmergingTechnologyAdvisors/node-serialport/issues/1347)) ([a3b8d35](https://github.com/EmergingTechnologyAdvisors/node-serialport/commit/a3b8d35))
-* **parsers:** Add cctalk parsers ([#1342](https://github.com/EmergingTechnologyAdvisors/node-serialport/issues/1342)) ([bcb492f](https://github.com/EmergingTechnologyAdvisors/node-serialport/commit/bcb492f))
-* **test:** tone down codecov comments ([#1289](https://github.com/EmergingTechnologyAdvisors/node-serialport/issues/1289)) ([749ffac](https://github.com/EmergingTechnologyAdvisors/node-serialport/commit/749ffac))
-* **windows:** Add ERROR_INVALID_PARAMETER to supported bindings errors ([#1354](https://github.com/EmergingTechnologyAdvisors/node-serialport/issues/1354)) ([4ff9c67](https://github.com/EmergingTechnologyAdvisors/node-serialport/commit/4ff9c67))
+* **open:** Throw on incorrect baudrate option ([#1347](https://github.com/node-serialport/node-serialport/issues/1347)) ([a3b8d35](https://github.com/node-serialport/node-serialport/commit/a3b8d35))
+* **parsers:** Add cctalk parsers ([#1342](https://github.com/node-serialport/node-serialport/issues/1342)) ([bcb492f](https://github.com/node-serialport/node-serialport/commit/bcb492f))
+* **test:** tone down codecov comments ([#1289](https://github.com/node-serialport/node-serialport/issues/1289)) ([749ffac](https://github.com/node-serialport/node-serialport/commit/749ffac))
+* **windows:** Add ERROR_INVALID_PARAMETER to supported bindings errors ([#1354](https://github.com/node-serialport/node-serialport/issues/1354)) ([4ff9c67](https://github.com/node-serialport/node-serialport/commit/4ff9c67))
 
 
 ### Bug Fixes
 
-* **docs:** Add a note about windows support ([76b7191](https://github.com/EmergingTechnologyAdvisors/node-serialport/commit/76b7191)), closes [#1299](https://github.com/EmergingTechnologyAdvisors/node-serialport/issues/1299)
-* **docs:** add missing parsers to properties list ([3faadac](https://github.com/EmergingTechnologyAdvisors/node-serialport/commit/3faadac))
-* **docs:** correct default highWaterMark to 65536 bytes ([e83ec4e](https://github.com/EmergingTechnologyAdvisors/node-serialport/commit/e83ec4e))
-* **docs:** Fixed typo in upgrade guide ([#1321](https://github.com/EmergingTechnologyAdvisors/node-serialport/issues/1321)) ([bf251a9](https://github.com/EmergingTechnologyAdvisors/node-serialport/commit/bf251a9))
-* **linux:** The productID should be a number not a description string ([#1279](https://github.com/EmergingTechnologyAdvisors/node-serialport/issues/1279)) ([bf46f68](https://github.com/EmergingTechnologyAdvisors/node-serialport/commit/bf46f68))
-* **package:** update debug to version 3.0.0 ([#1292](https://github.com/EmergingTechnologyAdvisors/node-serialport/issues/1292)) ([4987750](https://github.com/EmergingTechnologyAdvisors/node-serialport/commit/4987750))
-* **tests:** fixup for [#1279](https://github.com/EmergingTechnologyAdvisors/node-serialport/issues/1279) ([#1285](https://github.com/EmergingTechnologyAdvisors/node-serialport/issues/1285)) ([56074f6](https://github.com/EmergingTechnologyAdvisors/node-serialport/commit/56074f6))
-* **windows:** Add option to disable RTS ([#1277](https://github.com/EmergingTechnologyAdvisors/node-serialport/issues/1277)) ([5b8d163](https://github.com/EmergingTechnologyAdvisors/node-serialport/commit/5b8d163))
-* **windows:** Asynchronous callbacks for reading and writing ([#1328](https://github.com/EmergingTechnologyAdvisors/node-serialport/issues/1328)) ([69de595](https://github.com/EmergingTechnologyAdvisors/node-serialport/commit/69de595)), closes [#1221](https://github.com/EmergingTechnologyAdvisors/node-serialport/issues/1221)
-* **windows:** Parse more types of pnpIds ([#1288](https://github.com/EmergingTechnologyAdvisors/node-serialport/issues/1288)) ([0b554d7](https://github.com/EmergingTechnologyAdvisors/node-serialport/commit/0b554d7)), closes [#1220](https://github.com/EmergingTechnologyAdvisors/node-serialport/issues/1220)
+* **docs:** Add a note about windows support ([76b7191](https://github.com/node-serialport/node-serialport/commit/76b7191)), closes [#1299](https://github.com/node-serialport/node-serialport/issues/1299)
+* **docs:** add missing parsers to properties list ([3faadac](https://github.com/node-serialport/node-serialport/commit/3faadac))
+* **docs:** correct default highWaterMark to 65536 bytes ([e83ec4e](https://github.com/node-serialport/node-serialport/commit/e83ec4e))
+* **docs:** Fixed typo in upgrade guide ([#1321](https://github.com/node-serialport/node-serialport/issues/1321)) ([bf251a9](https://github.com/node-serialport/node-serialport/commit/bf251a9))
+* **linux:** The productID should be a number not a description string ([#1279](https://github.com/node-serialport/node-serialport/issues/1279)) ([bf46f68](https://github.com/node-serialport/node-serialport/commit/bf46f68))
+* **package:** update debug to version 3.0.0 ([#1292](https://github.com/node-serialport/node-serialport/issues/1292)) ([4987750](https://github.com/node-serialport/node-serialport/commit/4987750))
+* **tests:** fixup for [#1279](https://github.com/node-serialport/node-serialport/issues/1279) ([#1285](https://github.com/node-serialport/node-serialport/issues/1285)) ([56074f6](https://github.com/node-serialport/node-serialport/commit/56074f6))
+* **windows:** Add option to disable RTS ([#1277](https://github.com/node-serialport/node-serialport/issues/1277)) ([5b8d163](https://github.com/node-serialport/node-serialport/commit/5b8d163))
+* **windows:** Asynchronous callbacks for reading and writing ([#1328](https://github.com/node-serialport/node-serialport/issues/1328)) ([69de595](https://github.com/node-serialport/node-serialport/commit/69de595)), closes [#1221](https://github.com/node-serialport/node-serialport/issues/1221)
+* **windows:** Parse more types of pnpIds ([#1288](https://github.com/node-serialport/node-serialport/issues/1288)) ([0b554d7](https://github.com/node-serialport/node-serialport/commit/0b554d7)), closes [#1220](https://github.com/node-serialport/node-serialport/issues/1220)
 
 
 ### Chores
 
-* **binaries:** Lets switch to prebuild! ([#1282](https://github.com/EmergingTechnologyAdvisors/node-serialport/issues/1282)) ([8c36e99](https://github.com/EmergingTechnologyAdvisors/node-serialport/commit/8c36e99))
+* **binaries:** Lets switch to prebuild! ([#1282](https://github.com/node-serialport/node-serialport/issues/1282)) ([8c36e99](https://github.com/node-serialport/node-serialport/commit/8c36e99))
 
 ### BREAKING CHANGES
 
@@ -57,7 +57,7 @@
 
 Version 5.0.0 🎉
 -------------
-Nearly [a year in the making](https://github.com/EmergingTechnologyAdvisors/node-serialport/compare/4.0.7...5.0.0-beta9) Node SerialPort 5.0.0 is a major rewrite that improves stability, compatibility and performance. The api surface is similar to version 4 there have been a number of changes to ensure consistent error handling and operation of a serial port. Notably we are now a [`Stream`](https://nodejs.org/api/stream.html)! We can also introduce a bindings layer. A small low level api to provide access to underlying hardware. External bindings written in other languages or targeting other platforms can now be used.
+Nearly [a year in the making](https://github.com/node-serialport/node-serialport/compare/4.0.7...5.0.0-beta9) Node SerialPort 5.0.0 is a major rewrite that improves stability, compatibility and performance. The api surface is similar to version 4 there have been a number of changes to ensure consistent error handling and operation of a serial port. Notably we are now a [`Stream`](https://nodejs.org/api/stream.html)! We can also introduce a bindings layer. A small low level api to provide access to underlying hardware. External bindings written in other languages or targeting other platforms can now be used.
 
 Some major cpu performance gains on unix platforms can be found and we're less buggy and better performing on Windows too.
 

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -15,7 +15,7 @@ There are a lot of ways to get involved and help out:
 <a name="reporting-issues"></a>
 ## Reporting An Issue
 
-SerialPort does it's [issue tracking](https://github.com/EmergingTechnologyAdvisors/node-serialport/issues) through github. To report an issue first search the repo to make sure that it has not been reported before.  If no one has reported the bug before, create a new issue and be sure to include the following information:
+SerialPort does it's [issue tracking](https://github.com/node-serialport/node-serialport/issues) through github. To report an issue first search the repo to make sure that it has not been reported before.  If no one has reported the bug before, create a new issue and be sure to include the following information:
 
 Operating System and Hardware:
 NodeJS Version:
@@ -36,7 +36,7 @@ If the issue has been reported before but you have new information to help troub
 
 <a name="requesting-features"></a>
 ## Requesting Features
-To request a new feature be added take a look at the [current roadmap](https://github.com/EmergingTechnologyAdvisors/node-serialport/issues/746) and create a [github issue](https://github.com/EmergingTechnologyAdvisors/node-serialport/issues) and include:
+To request a new feature be added take a look at the [current roadmap](https://github.com/node-serialport/node-serialport/issues/746) and create a [github issue](https://github.com/node-serialport/node-serialport/issues) and include:
 
 **What feature you'd like to see:**
 **Why this is important to you:** (this is here because it's interesting knowing what cool things people are working on and also could help community members make suggestions for work-arounds until the feature is built)
@@ -56,12 +56,12 @@ It's very important that your pull requests include all of the above in order fo
 <a name="writing-tests"></a>
 ## Writing Tests
 
-Tests are written using [mocha](https://mochajs.org/), [chai](http://chaijs.com/) and [sinon](http://sinonjs.org/).  If you are having issues making a test pass, ask for help in the SerialPort [gitter](https://gitter.im/EmergingTechnologyAdvisors/node-serialport) room or on your PR.  Tests can be the hardest part to write when contributing code, so don't be discouraged.
+Tests are written using [mocha](https://mochajs.org/), [chai](http://chaijs.com/) and [sinon](http://sinonjs.org/).  If you are having issues making a test pass, ask for help in the SerialPort [gitter](https://gitter.im/node-serialport/node-serialport) room or on your PR.  Tests can be the hardest part to write when contributing code, so don't be discouraged.
 
 <a name="writing-docs"></a>
 ## Writing Documentation
 
-We are always looking to improve our docs.  If you find that any are lacking information or have wrong information, fix and submit a PR.  If you're looking for areas to start writing docs for, see the [docs](https://github.com/EmergingTechnologyAdvisors/node-serialport/labels/docs) label in issues.
+We are always looking to improve our docs.  If you find that any are lacking information or have wrong information, fix and submit a PR.  If you're looking for areas to start writing docs for, see the [docs](https://github.com/node-serialport/node-serialport/labels/docs) label in issues.
 
 We use [jsdoc](http://usejsdoc.org/) and [jsdoc-to-markdown](https://github.com/jsdoc2md/jsdoc-to-markdown) to generate our docs. Make your changes to `.docs/README.hbs` or the documentation blocks in the JavaScript files and run `npm run docs` to update `README.md`.
 

diff --git a/PUBLISHING.md b/PUBLISHING.md
@@ -8,11 +8,10 @@ This can be checked in the .travis.yml file and appveyor.yml file. Within these
 
 1. Bump up npm version in `package.json`
 2. Run `npm run changelog` and modify `CHANGELOG.md` if needed
-3. Update the `.docs/README.hbs` to reference this current version and to previous major version docs then regenerate docs `npm run docs`.
-4. Commit everything then generate new tags based on package.json version number with `git tag v6.0.0 -a` and include the change log in the tag's annotation. (beta `git tag v6.0.0-beta3 -a`)
-5. Push tags to Github with `git push --tags`
-6. Wait for the CI to publish all the binaries. Remove the content of the Github release message so the tag's text shows.
-7. `rm -rf package-lock.json node_modules build && npm install`
-8. When the entire matrix succeeds and all binaries exist run `npm publish` or `npm publish --tag beta`.
-9. Kick off the build matrix for either the master or beta branch on [serialport-test-pilot](https://travis-ci.org/j5js/serialport-test-pilot). It will install serialport from npm on a wide range of systems.
-10. Let everyone know 🎉
+3. Commit everything then generate new tags based on package.json version number with `git tag v6.0.0 -a` and include the change log in the tag's annotation. (beta `git tag v6.0.0-beta3 -a`)
+4. Push tags to Github with `git push --tags`
+5. Wait for the CI to publish all the binaries. Remove the content of the Github release message so the tag's text shows.
+6. `rm -rf package-lock.json node_modules build && npm install`
+7. When the entire matrix succeeds and all binaries exist run `npm publish` or `npm publish --tag beta`.
+8. Kick off the build matrix for either the master or beta branch on [serialport-test-pilot](https://travis-ci.org/j5js/serialport-test-pilot). It will install serialport from npm on a wide range of systems.
+9. Let everyone know 🎉