Improve 'get started' doc. #152
Merged
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
3 tasks
chmanie
previously requested changes
Jun 4, 2018
docs/_Docs_GetStarted.md
Outdated
|
|
||
| ### Initialize your project | ||
| Create a new directory for your project, and initialize it with npm | ||
| TODO: clarify what steps this hash |
docs/_Docs_GetStarted.md
Outdated
| Once the colony is configured and everything has been initialized, you can start the task workflow. | ||
|
|
||
| ## The Task Life-cycle | ||
| The most useful tool within a colony is the `task` method. Tasks are used to coordinate work, track reputation, and ultimately the only way to get paid through a colony. See [tasks](/colonynetwork/docs-tasks/) for a complete description of what tasks are within a colony. | ||
|
|
||
| ### Create |
There was a problem hiding this comment.
We should probably add a link to a section which explains how to get the spec hash?
There was a problem hiding this comment.
I have adjusted to include a short explanation that the hash could be a reference to an IPFS file, but that it doesn't have to be.
|
Ok, so I think this is complete enough to merge, and to re-deploy the docs to get these changes out there. Some people are already starting to mess around with the quickstart, so I think it's important that we get this out there, and then add the IPFS/hackathonStarter content in a subsequent round of edits. |
JamesLefrere
approved these changes
Jun 5, 2018
Aligns the step-by-step explanation of 'get started' with the actions that are performed by scripts written in hackathonStarter/
JamesLefrere
force-pushed
the
maintenance/150-get-started
branch
from
50faab3
to
f314f7c
Compare
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.
Aligns the step-by-step explanation of 'get started' with the actions
that are performed by scripts written in hackathonStarter/
Will close #150