add docs, fixes #181 #183
Merged
add docs, fixes #181 #183
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This is part of the docs migration from the Wiki to the main repository. (#181) I've renamed the "Home" doc page to README so it is shown when you open the repository's [`doc` directory on GitHub](https://github.com/JSRocksHQ/harmonic/tree/doc/doc). (note: I'll erase this branch after merging, if you are reading the commit history then replace "doc/doc" with "master/doc") Please test to see if all the documentation's links are working properly. I've fixed a few typos and broken links in this migration as well. Side-note: I've removed the "LICENSE" from the `package.json`'s `files` array as the LICENSE file is always included regardless of settings (https://docs.npmjs.com/files/package.json#files).
|
This is looking good to me, I'll go ahead and merge this. Please send PRs or comment if you find any issues in the new docs. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is part of the docs migration from the Wiki to the main repository. (#181)
I've renamed the "Home" doc page to README so it is shown when you open the repository's
docdirectory on GitHub. (note: I'll erase this branch after merging, if you are reading the commit history then replace "doc/doc" with "master/doc")Please test to see if all the documentation's links are working properly.
I've fixed a few typos and broken links in this migration as well.
Side-note: I've removed the "LICENSE" from the
package.json'sfilesarray as the LICENSE file is always included regardless of settings (https://docs.npmjs.com/files/package.json#files).