Skip to content

add docs, fixes #181 - #183

Merged
UltCombo merged 1 commit into
masterfrom
doc
Jan 11, 2016
Merged

add docs, fixes #181#183
UltCombo merged 1 commit into
masterfrom
doc

Conversation

@UltCombo

Copy link
Copy Markdown
Member

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. (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 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).
@UltCombo

Copy link
Copy Markdown
Member Author

The failing test is due to ESLint; should be fixed once we update the dependencies (#176, #177).

@UltCombo

Copy link
Copy Markdown
Member Author

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.

@UltCombo
UltCombo merged commit 1e50201 into master Jan 11, 2016
@UltCombo
UltCombo deleted the doc branch January 11, 2016 01:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant