Skip to content

Commit

Permalink
feat(docs): Switch to JSDOC docs not in the readme
Browse files Browse the repository at this point in the history
- Improve a few docs here and there
  • Loading branch information
reconbot committed Nov 1, 2017
1 parent 22a36b1 commit 7edf2a0
Show file tree
Hide file tree
Showing 23 changed files with 201 additions and 1,422 deletions.
7 changes: 7 additions & 0 deletions .doclets.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
dir: lib
packageJson: package.json
articles:
- Overview: README.md
branches:
- master
- jsdoc
485 changes: 0 additions & 485 deletions .docs/README.hbs

This file was deleted.

10 changes: 0 additions & 10 deletions .docs/edit-warning.hbs

This file was deleted.

14 changes: 0 additions & 14 deletions .docs/sig-link.hbs

This file was deleted.

15 changes: 0 additions & 15 deletions .docs/sig-name.hbs

This file was deleted.

1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,4 @@ npm-debug.log
package-lock.json
Release/
prebuilds/
docs
34 changes: 34 additions & 0 deletions .jsdoc.json
Original file line number Diff line number Diff line change
@@ -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
}
}
1 change: 1 addition & 0 deletions .npmignore
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,4 @@ node_modules
npm-debug.log
package-lock.json
Release/
docs
1 change: 0 additions & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,6 @@ script:
npm run lint
fi;
- npm run docs:diff
- node ./
- npm test

Expand Down
15 changes: 7 additions & 8 deletions PUBLISHING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 🎉
Loading

0 comments on commit 7edf2a0

Please sign in to comment.