Release colonyJS about colonyjs HOT 3 CLOSED

General Comments

These docs look very sharp and clean, and are a wonderful guide to the depth of thought behind this project. They will inspire confidence and excitement.

Motto: The best tool to poke the colony network. Slightly odd motto? Isn't this a tool to build clients using Colony?

"The ColonyJS library is a tool we’ve built for the developers out there who want to use Colony to power their projects." Shorter: "The ColonyJS library is a tool to help developers use Colony to power their projects."

ColonyDocs logo, top left, returns us to "colony docs index page" which doesn't exist.

Clicking docs from the landing page takes us to QuickStart, which is in the middle of the nav options on the left. It feels a little funny to start off in the middle instead of at the top.

Overview

Diagram link doesn't work?

This paragraph is also used on the Adapters page, first sentence could be shorter:
"Adapters are the ColonyJS solution for there being many different ways to access the Ethereum blockchain, through various JavaScript libraries. Adapters provide a wrapper for such libraries that enforce a standard and predictable API for use with Colony's contracts."

Maybe: "Adapters represent the ColonyJS solution for the many different ways to access the Ethereum blockchain provided by various JavaScript libraries. Adapters provide a wrapper for such libraries that enforces a standard and predictable API for use with Colony's contracts."

Get Started

"Using ColonyJS, you can query the blockchain for information about tasks, create new tasks and modify them, commit and reveal ratings, finalize and trigger task payouts -- all from within your application."

Could use a final "and" in that sentence: "ratings, and finalize and trigger". Feel free to ignore.

Contract Client

The links on this page to Colony Network Documentation don't work, sadly.

Quickstart

First sentence uses colonyJS. Should be ColonyJS?

Loaders

Here we say TrufflePig, on Quickstart we say Trufflepig.

Adapters

Has the adapters sentence from above.

Also second sentence missing a period.

API/ColonyNetworkClient and /ColonyClient

These sections have many functions followed by short definitions. Some of these definitions end with periods and some do not.

from colonyjs.

Another proofing round:

https://joincolony.github.io/colonynetwork/docs-colony/#reputation-and-tokens

Final paragraph: Its, should be it's.

https://joincolony.github.io/colonynetwork/docs-glossary-of-terms/#meta-colony

"It's remit" should be "Its remit"

https://joincolony.github.io/colonynetwork/docs-tasks/#task-structure

Needs actual link.

https://joincolony.github.io/colonynetwork/docs-tasks/#roles

change to 8-bit numbers

https://joincolony.github.io/colonynetwork/docs-reputation/#reputation-bootstrapping

"existing trust which exists within the team", redundant

Change to "existing trust within the team"

https://joincolony.github.io/colonynetwork/docs-pots-and-funding/

Second para typo: assinging --> assigning

https://joincolony.github.io/colonynetwork/docs-the-meta-colony-and-clny/

"it's remit" again

https://joincolony.github.io/colonyjs/docs-quickstart/#environment-prerequisites

Use TrufflePig instead of Trufflepig

https://joincolony.github.io/colonyjs/api-loaders/

Period at end of first sentence

https://joincolony.github.io/colonyjs/api-loaders/#httpcontractloader

Period at end of last sentence

https://joincolony.github.io/colonyjs/api-colonyclient/#waiverewardpayoutssend-numpayouts--options

Has this expression: '##TaskMultiSig

That's probably meant to be markup of some sort

from colonyjs.

Published! The only remaining task is docs related:

create joincolony.github.io index page because currently it looks like this

from colonyjs.