Skip to content

Commit a05ca22

Browse files
committed
Added Documentation note to js-guidelines
This references the Awesome Documentation effort. See ipfs/js-ipfs#615
1 parent 607c2f2 commit a05ca22

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

js-project-guidelines.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ Also, remember:
2626
- [Testing](#testing)
2727
- [Building](#building)
2828
- [Releasing](#releasing)
29+
- [Documentation](#documentation)
2930
- [Commits](#commits)
3031
- [Commit Message Format](#commit-message-format)
3132
- [Revert](#revert)
@@ -127,6 +128,12 @@ Each time a new release happens, these are the steps we follow to make sure noth
127128
7. Push to GitHub
128129
8. Publish to npm
129130

131+
### Documentation
132+
133+
We use [documentation.js](https://github.com/documentationjs/documentation/tree/master/docs) to document our JavaScript repositories. For each repo, we use [this gulp task](https://github.com/documentationjs/gulp-documentation). An example for how to use JSDoc to document everything can be seen in [this PR to js-ipfs](https://github.com/ipfs/js-ipfs/pull/651). Ideally, we create a `docs` folder in each repository, and make sure it is not tracked to git.
134+
135+
We use [`aegir-docs`](https://github.com/dignifiedquire/aegir) for the actual generation, which relies on JSDoc style comments. For more on aegir, see [the section below](#aegir).
136+
130137
## Commits
131138

132139
We have very precise rules over how our git commit messages can be formatted.

0 commit comments

Comments
 (0)