New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: improve developer guidebook #233

Merged
merged 6 commits into from Feb 7, 2019

Conversation

Projects
None yet
5 participants
@JeremiGendron
Copy link
Contributor

JeremiGendron commented Jan 10, 2019

Proposed changes

Refactor the developer guidebook to include more complete instructions on base dependencies and workflow.

Will include more details if necessary or refactor at maintainers' will without problem.

Types of changes

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Refactoring (improve a current implementation without adding a new feature or fixing a bug)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Build (changes that affect the build system)
  • Docs (documentation only changes)
  • Test (adding missing tests or fixing existing tests)
  • Other... Please describe:

Checklist

@kristjank

This comment has been minimized.

Copy link
Member

kristjank commented Jan 12, 2019

@JeremiGendron we added some bigger content, so we have some conflicts now. When you can resolve them please.

@JeremiGendron

This comment has been minimized.

Copy link
Contributor Author

JeremiGendron commented Jan 12, 2019

sure thing

@faustbrian

This comment has been minimized.

Copy link
Contributor

faustbrian commented Jan 16, 2019

The cookbook was moved to the guidebook.

@JeremiGendron JeremiGendron force-pushed the JeremiGendron:docs/improve-developer-guidebook branch from 3d38af6 to 9c6c52f Jan 17, 2019

Show resolved Hide resolved docs/cookbook/README.md Outdated
Show resolved Hide resolved docs/cookbook/README.md Outdated
Show resolved Hide resolved docs/guidebook/core/development.md Outdated
Show resolved Hide resolved docs/guidebook/core/development.md Outdated
```
This will ensure that your local files reflect those of the Core's development branch.

Finally, we can setup the entire repository with one command:

This comment has been minimized.

@KaiserKarel

KaiserKarel Jan 22, 2019

Contributor

set up

cd core
```

For example, the `.nvmrc` file located at `core/.nvmrc` will tell us which version of node we should use for development.

This comment has been minimized.

@KaiserKarel

KaiserKarel Jan 22, 2019

Contributor

consider using NodeJS as often as possible, as node might confuse beginners. Do we mean an Ark Node, relay or forging, or programming language?

```

Just follow those steps, and you are ready to get started. Happy Hacking!
[Yarn](https://yarnpkg.com) is the package manager used by Ark Core, it replaces npm from here on out.

This comment has been minimized.

@KaiserKarel

KaiserKarel Jan 22, 2019

Contributor

; or a new sentence is slightly more appropriate

Show resolved Hide resolved docs/guidebook/core/development.md Outdated
@JeremiGendron

This comment has been minimized.

Copy link
Contributor Author

JeremiGendron commented Jan 22, 2019

@faustbrian

This comment has been minimized.

Copy link
Contributor

faustbrian commented Jan 25, 2019

@JeremiGendron any progress on this or should @KaiserKarel finish it?

@JeremiGendron JeremiGendron force-pushed the JeremiGendron:docs/improve-developer-guidebook branch from 9956d03 to 58811ff Jan 25, 2019

@faustbrian

This comment has been minimized.

Copy link
Contributor

faustbrian commented Feb 2, 2019

@JeremiGendron conflicts and some links still look wrong

@ArkEcosystemBot

This comment has been minimized.

Copy link
Member

ArkEcosystemBot commented Feb 7, 2019

@JeremiGendron A contributor has approved this PR. A maintainer will merge this PR shortly. If it shouldn't be merged yet, please leave a comment saying so and we'll wait.

Thank you for your contribution!

@faustbrian faustbrian merged commit e408091 into ArkEcosystem:master Feb 7, 2019

1 check passed

ci/circleci: build Your tests passed on CircleCI!
Details
@ArkEcosystemBot

This comment has been minimized.

Copy link
Member

ArkEcosystemBot commented Feb 7, 2019

@JeremiGendron Your pull request has been merged and marked as tier 4. It will earn you $10 USD.

@faustbrian

This comment has been minimized.

Copy link
Contributor

faustbrian commented Feb 7, 2019

@KaiserKarel could you take a look if anything in here clashes with changes you made lately and adjust them in an upcoming PR of yours.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment