Skip to content

Commit 60fc047

Browse files
authored
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
1 parent 22a36b1 commit 60fc047

25 files changed

+244
-1468
lines changed

.doclets.yml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
dir: lib
2+
packageJson: package.json
3+
articles:
4+
- Overview: README.md
5+
branches:
6+
- master
7+
- jsdoc

.docs/README.hbs

Lines changed: 0 additions & 485 deletions
This file was deleted.

.docs/edit-warning.hbs

Lines changed: 0 additions & 10 deletions
This file was deleted.

.docs/sig-link.hbs

Lines changed: 0 additions & 14 deletions
This file was deleted.

.docs/sig-name.hbs

Lines changed: 0 additions & 15 deletions
This file was deleted.

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,4 @@ npm-debug.log
77
package-lock.json
88
Release/
99
prebuilds/
10+
docs

.jsdoc.json

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
{
2+
"tags": {
3+
"allowUnknownTags": true,
4+
"dictionaries": ["jsdoc"]
5+
},
6+
"source": {
7+
"include": ["lib", "README.md"],
8+
"includePattern": ".+\\.(js|jsx)?$"
9+
},
10+
"plugins": [
11+
"plugins/markdown"
12+
],
13+
"markdown": {
14+
"parser": "gfm",
15+
"hardwrap": true,
16+
"excludeTags": []
17+
},
18+
"templates": {
19+
"cleverLinks": true,
20+
"monospaceLinks": true
21+
},
22+
"opts": {
23+
"template": "node_modules/docdash",
24+
"encoding": "utf8",
25+
"private": true,
26+
"destination": "./docs/",
27+
"recurse": true,
28+
"_tutorials": "./examples"
29+
},
30+
"docdash": {
31+
"static": true,
32+
"sort": true
33+
}
34+
}

.npmignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,3 +27,4 @@ node_modules
2727
npm-debug.log
2828
package-lock.json
2929
Release/
30+
docs

.travis.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,6 @@ script:
9191
npm run lint
9292
fi;
9393
94-
- npm run docs:diff
9594
- node ./
9695
- npm test
9796

CHANGELOG.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,53 @@
11
<a name="6.0.4"></a>
2-
## [6.0.4](https://github.com/EmergingTechnologyAdvisors/node-serialport/compare/v6.0.3...v6.0.4) (2017-10-26)
2+
## [6.0.4](https://github.com/node-serialport/node-serialport/compare/v6.0.3...v6.0.4) (2017-10-26)
33

44

55
### Bug Fixes
66

7-
* **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))
8-
* **windows:** bad parameter for ReadThread (windows) ([#1377](https://github.com/EmergingTechnologyAdvisors/node-serialport/issues/1377)) ([6f3afbe](https://github.com/EmergingTechnologyAdvisors/node-serialport/commit/6f3afbe))
7+
* **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))
8+
* **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))
99

1010

1111

1212
<a name="6.0.3"></a>
13-
## [6.0.3](https://github.com/EmergingTechnologyAdvisors/node-serialport/compare/v6.0.0...v6.0.3) (2017-10-22)
13+
## [6.0.3](https://github.com/node-serialport/node-serialport/compare/v6.0.0...v6.0.3) (2017-10-22)
1414

1515
### Bug Fixes
1616

17-
* **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)
18-
* **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))
17+
* **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)
18+
* **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))
1919

2020

2121

2222
<a name="6.0.0"></a>
23-
# [6.0.0](https://github.com/EmergingTechnologyAdvisors/node-serialport/compare/5.0.0...v6.0.0) (2017-10-09)
23+
# [6.0.0](https://github.com/node-serialport/node-serialport/compare/5.0.0...v6.0.0) (2017-10-09)
2424

2525

2626
### Features
2727

28-
* **open:** Throw on incorrect baudrate option ([#1347](https://github.com/EmergingTechnologyAdvisors/node-serialport/issues/1347)) ([a3b8d35](https://github.com/EmergingTechnologyAdvisors/node-serialport/commit/a3b8d35))
29-
* **parsers:** Add cctalk parsers ([#1342](https://github.com/EmergingTechnologyAdvisors/node-serialport/issues/1342)) ([bcb492f](https://github.com/EmergingTechnologyAdvisors/node-serialport/commit/bcb492f))
30-
* **test:** tone down codecov comments ([#1289](https://github.com/EmergingTechnologyAdvisors/node-serialport/issues/1289)) ([749ffac](https://github.com/EmergingTechnologyAdvisors/node-serialport/commit/749ffac))
31-
* **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))
28+
* **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))
29+
* **parsers:** Add cctalk parsers ([#1342](https://github.com/node-serialport/node-serialport/issues/1342)) ([bcb492f](https://github.com/node-serialport/node-serialport/commit/bcb492f))
30+
* **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))
31+
* **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))
3232

3333

3434
### Bug Fixes
3535

36-
* **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)
37-
* **docs:** add missing parsers to properties list ([3faadac](https://github.com/EmergingTechnologyAdvisors/node-serialport/commit/3faadac))
38-
* **docs:** correct default highWaterMark to 65536 bytes ([e83ec4e](https://github.com/EmergingTechnologyAdvisors/node-serialport/commit/e83ec4e))
39-
* **docs:** Fixed typo in upgrade guide ([#1321](https://github.com/EmergingTechnologyAdvisors/node-serialport/issues/1321)) ([bf251a9](https://github.com/EmergingTechnologyAdvisors/node-serialport/commit/bf251a9))
40-
* **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))
41-
* **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))
42-
* **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))
43-
* **windows:** Add option to disable RTS ([#1277](https://github.com/EmergingTechnologyAdvisors/node-serialport/issues/1277)) ([5b8d163](https://github.com/EmergingTechnologyAdvisors/node-serialport/commit/5b8d163))
44-
* **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)
45-
* **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)
36+
* **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)
37+
* **docs:** add missing parsers to properties list ([3faadac](https://github.com/node-serialport/node-serialport/commit/3faadac))
38+
* **docs:** correct default highWaterMark to 65536 bytes ([e83ec4e](https://github.com/node-serialport/node-serialport/commit/e83ec4e))
39+
* **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))
40+
* **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))
41+
* **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))
42+
* **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))
43+
* **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))
44+
* **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)
45+
* **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)
4646

4747

4848
### Chores
4949

50-
* **binaries:** Lets switch to prebuild! ([#1282](https://github.com/EmergingTechnologyAdvisors/node-serialport/issues/1282)) ([8c36e99](https://github.com/EmergingTechnologyAdvisors/node-serialport/commit/8c36e99))
50+
* **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))
5151

5252
### BREAKING CHANGES
5353

@@ -57,7 +57,7 @@
5757

5858
Version 5.0.0 🎉
5959
-------------
60-
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.
60+
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.
6161

6262
Some major cpu performance gains on unix platforms can be found and we're less buggy and better performing on Windows too.
6363

CONTRIBUTING.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ There are a lot of ways to get involved and help out:
1515
<a name="reporting-issues"></a>
1616
## Reporting An Issue
1717

18-
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:
18+
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:
1919

2020
Operating System and Hardware:
2121
NodeJS Version:
@@ -36,7 +36,7 @@ If the issue has been reported before but you have new information to help troub
3636

3737
<a name="requesting-features"></a>
3838
## Requesting Features
39-
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:
39+
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:
4040

4141
**What feature you'd like to see:**
4242
**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
5656
<a name="writing-tests"></a>
5757
## Writing Tests
5858

59-
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.
59+
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.
6060

6161
<a name="writing-docs"></a>
6262
## Writing Documentation
6363

64-
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.
64+
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.
6565

6666
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`.
6767

PUBLISHING.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,10 @@ This can be checked in the .travis.yml file and appveyor.yml file. Within these
88

99
1. Bump up npm version in `package.json`
1010
2. Run `npm run changelog` and modify `CHANGELOG.md` if needed
11-
3. Update the `.docs/README.hbs` to reference this current version and to previous major version docs then regenerate docs `npm run docs`.
12-
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`)
13-
5. Push tags to Github with `git push --tags`
14-
6. Wait for the CI to publish all the binaries. Remove the content of the Github release message so the tag's text shows.
15-
7. `rm -rf package-lock.json node_modules build && npm install`
16-
8. When the entire matrix succeeds and all binaries exist run `npm publish` or `npm publish --tag beta`.
17-
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.
18-
10. Let everyone know 🎉
11+
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`)
12+
4. Push tags to Github with `git push --tags`
13+
5. Wait for the CI to publish all the binaries. Remove the content of the Github release message so the tag's text shows.
14+
6. `rm -rf package-lock.json node_modules build && npm install`
15+
7. When the entire matrix succeeds and all binaries exist run `npm publish` or `npm publish --tag beta`.
16+
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.
17+
9. Let everyone know 🎉

0 commit comments

Comments
 (0)