Add dev setup guide #1852
Add dev setup guide #1852
Conversation
ManfredKarrer
commented
Nov 1, 2018
ManfredKarrer
commented
- Move outdated and not highly relevant files to sub directories
- Move outdated and not highly relevant files to sub directories
|
As soon that is merged I will replace the Wiki entries with a link to that file. Wiki has no commit history so keeping that in the file is better IMO. |
| Compensation for your contributions | ||
| --------- | ||
| Bisq is not a company but operates as a [DAO](https://docs.bisq.network/dao/phase-zero.html). For any development work merged into the Bisq master branch you can file a [compensation request](https://github.com/bisq-network/compensation) and earn BSQ (the DAO native token). Learn more about the Bisq DAO at our [docs](https://docs.bisq.network/dao/phase-zero.html) pages. | ||
|
|
There was a problem hiding this comment.
Just a comment unrelated to your changes for this PR, I was wondering if this CONTRIBUTING doc is necessary here? Should we merge all its content into the one under bisq-docs?
Also since that is where the main CONTRIBUTING.md doc for this repo points to.
There was a problem hiding this comment.
I would like to leave it to @cbeams if he prefers to merge both files.
There was a problem hiding this comment.
CONTRIBUTING.md is there because it is recognized and dealt with specially by GitHub. Namely, it asks users to read the file when submitting a PR (as you may have noticed). So we could make it a placeholder with link(s) pointing to canonical doc(s) elsewhere in the repo, but the file itself should remain in place, as it's the hook into GitHub's PR system.
|
The wiki does have revision history. But I agree moving it into the repo makes it easier for anyone to submit PRs to update its content since the wiki requires granting users access. |
|
A few additional comments:
|
There was a problem hiding this comment.
utACK -
besides smaller typos (see comments) all is looking good. Thanks for putting this together @ManfredKarrer!
doc/DEV_SETUP.md
Outdated
|
|
||
| #### Use the predefined setup | ||
|
|
||
| The creation of the genesis tx is a bit cumbersome. To make it easier to get started you can use the [Bisq_DAO_regtest_setup.zip](https://github.com/bisq-network/bisq/tree/master/doc/Bisq_DAO_regtest_setup.zip) file which you find here in the same directory. |
There was a problem hiding this comment.
...file which you find here in the same directory.
Not sure if wee need the "which your find...."
|
@devinbileck |
|
Updated to reflect the feeback and will merge now. Feel free to add other changes in a new PR... |
|
@devinbileck Ah forgot to answer another question: |
|
@ManfredKarrer FYI, when selecting the Wiki, it just lists the Pages rather than directing to the Bisq page: |
|
Ah... do you know how to change that? If so feel free to change or improve... |
|
I think it needs to be named Home.md, rather than Bisq.md. |
|
Ah, thanks! |
|
I'm glad to see the Wiki get cleared out. I've been meaning to suggest this or do it myself for quite a while. Note that I restored the https://github.com/bisq-network/bisq/wiki/Arbitration-System page, though, as we have links coming into it from within the arbitration interface. Once those links are gone, we can remove that page too, but in the meantime it's better to leave the page in place and avoid the bad UX of 404s. |
|
Ah thanks! Will try to change the links... |
