<p>This PR simplifies and restructures our developer documentation for ease of discovery and use. Major changes include:</p>
<ul>
<li>Breaking up the root-level README into docs/build.md and docs/idea-import.md</li>
<li>A complete rewrite of CONTRIBUTING.md, loosely based on the structure of Bitcoin Core's own CONTRIBUTING.md.</li>
<li>Separating out <code>dev-setup.md</code> and <code>dao-setup.md</code>, as having the two sets of instructions intermixed was a bit overwhelming and confusing.</li>
<li>Removal of older files under scripts and misc. Each of these removals have been done in a dedicated commit for ease of reverting in case one is deemed important enough to keep around.</li>
</ul>
<p>The motivation for putting these changes together was that I followed the instructions in dev-setup.md (formerly DEV_SETUP.md), and found them useful and accurate, but a bit too much with all the DAO information intermixed. That led to separating the two docs out as mentioned above, which in turn led to this more general overhaul. Altogether, I think these docs are now in good shape for guiding any new contributor in the right direction, giving them just what they need to know at each step, and hopefully keeping the instructions simple and enjoyable to follow along the way.</p>
<p>Note that there is now a bit of overlap between the docs here and the "contributor docs" section of <a href="https://docs.bisq.network" rel="nofollow">https://docs.bisq.network</a>. I think it may make sense to make docs.bisq.network our user-facing and non-dev contributor documentation portal, while keeping all things dev here. Particularly where class names, command line args and the like are mentioned, it's better to keep such docs in the repository, so as to keep things in sync with the code that's being described. Where higher-level contributor documentation, e.g. roles, proposals and compensation are concerned, it probably makes sense to keep documenting that at docs.bisq.network. /cc <a class="user-mention" data-hovercard-type="user" data-hovercard-url="/hovercards?user_id=735155" data-octo-click="hovercard-link-click" data-octo-dimensions="link_type:self" href="https://github.com/m52go">@m52go</a></p>

<hr>

<h4>You can view, comment on, or merge this pull request online at:</h4>
<p>  <a href='https://github.com/bisq-network/bisq/pull/1924'>https://github.com/bisq-network/bisq/pull/1924</a></p>

<h4>Commit Summary</h4>
<ul>
  <li>Rename doc => docs</li>
  <li>Remove outdated build doc</li>
  <li>Remove misc/modena.css</li>
  <li>Remove misc/protobuffer_dev_notes.md</li>
  <li>Remove misc/ui-development-notes.md</li>
  <li>Remove scripts/bisq-sn.cron.sh</li>
  <li>Remove scripts/install_on_unix.sh</li>
  <li>Remove scripts/run_bisq_via_vps.md</li>
  <li>Move docs/CONTRIBUTING.md => CONTRIBUTING.md</li>
  <li>Extract separate docs from main README.md</li>
  <li>Rename DEV_SETUP.md => dev-setup.md</li>
  <li>Extract dao-setup.md from dev-setup.md</li>
  <li>Rename Bisq_DAO_regtest_setup.zip => dao-setup.zip</li>
  <li>Clean up dao-setup.zip contents</li>
  <li>Revise dev-setup.md</li>
  <li>Revise dao-setup.md</li>
  <li>Overhaul CONTRIBUTING.md</li>
</ul>

<h4>File Changes</h4>
<ul>
  <li>
    <strong>M</strong>
    <a href="https://github.com/bisq-network/bisq/pull/1924/files#diff-0">CONTRIBUTING.md</a>
    (86)
  </li>
  <li>
    <strong>M</strong>
    <a href="https://github.com/bisq-network/bisq/pull/1924/files#diff-1">README.md</a>
    (44)
  </li>
  <li>
    <strong>D</strong>
    <a href="https://github.com/bisq-network/bisq/pull/1924/files#diff-2">doc/Bisq_DAO_regtest_setup.zip</a>
    (0)
  </li>
  <li>
    <strong>D</strong>
    <a href="https://github.com/bisq-network/bisq/pull/1924/files#diff-3">doc/CONTRIBUTING.md</a>
    (33)
  </li>
  <li>
    <strong>D</strong>
    <a href="https://github.com/bisq-network/bisq/pull/1924/files#diff-4">doc/DEV_SETUP.md</a>
    (161)
  </li>
  <li>
    <strong>D</strong>
    <a href="https://github.com/bisq-network/bisq/pull/1924/files#diff-5">doc/misc/modena.css</a>
    (3617)
  </li>
  <li>
    <strong>D</strong>
    <a href="https://github.com/bisq-network/bisq/pull/1924/files#diff-6">doc/misc/protobuffer_dev_notes.md</a>
    (246)
  </li>
  <li>
    <strong>D</strong>
    <a href="https://github.com/bisq-network/bisq/pull/1924/files#diff-7">doc/misc/ui-development-notes.md</a>
    (98)
  </li>
  <li>
    <strong>D</strong>
    <a href="https://github.com/bisq-network/bisq/pull/1924/files#diff-8">doc/outdated/build.md</a>
    (136)
  </li>
  <li>
    <strong>D</strong>
    <a href="https://github.com/bisq-network/bisq/pull/1924/files#diff-9">doc/scripts/bisq-sn.cron.sh</a>
    (46)
  </li>
  <li>
    <strong>D</strong>
    <a href="https://github.com/bisq-network/bisq/pull/1924/files#diff-10">doc/scripts/install_on_unix.sh</a>
    (22)
  </li>
  <li>
    <strong>D</strong>
    <a href="https://github.com/bisq-network/bisq/pull/1924/files#diff-11">doc/scripts/run_bisq_via_vps.md</a>
    (63)
  </li>
  <li>
    <strong>A</strong>
    <a href="https://github.com/bisq-network/bisq/pull/1924/files#diff-12">docs/README.md</a>
    (9)
  </li>
  <li>
    <strong>A</strong>
    <a href="https://github.com/bisq-network/bisq/pull/1924/files#diff-13">docs/build.md</a>
    (29)
  </li>
  <li>
    <strong>A</strong>
    <a href="https://github.com/bisq-network/bisq/pull/1924/files#diff-14">docs/dao-setup.md</a>
    (83)
  </li>
  <li>
    <strong>A</strong>
    <a href="https://github.com/bisq-network/bisq/pull/1924/files#diff-15">docs/dao-setup.zip</a>
    (0)
  </li>
  <li>
    <strong>A</strong>
    <a href="https://github.com/bisq-network/bisq/pull/1924/files#diff-16">docs/dev-setup.md</a>
    (92)
  </li>
  <li>
    <strong>A</strong>
    <a href="https://github.com/bisq-network/bisq/pull/1924/files#diff-17">docs/idea-import.md</a>
    (17)
  </li>
</ul>

<h4>Patch Links:</h4>
<ul>
  <li><a href='https://github.com/bisq-network/bisq/pull/1924.patch'>https://github.com/bisq-network/bisq/pull/1924.patch</a></li>
  <li><a href='https://github.com/bisq-network/bisq/pull/1924.diff'>https://github.com/bisq-network/bisq/pull/1924.diff</a></li>
</ul>

<p style="font-size:small;-webkit-text-size-adjust:none;color:#666;">—<br />You are receiving this because you are subscribed to this thread.<br />Reply to this email directly, <a href="https://github.com/bisq-network/bisq/pull/1924">view it on GitHub</a>, or <a href="https://github.com/notifications/unsubscribe-auth/AkpZtk1QPXcmgI9g6qDbCvRfG-ijUACtks5uvFU_gaJpZM4YePmH">mute the thread</a>.<img src="https://github.com/notifications/beacon/AkpZtiC7G1fpwzbWC1tK2xHOBHyRFuR8ks5uvFU_gaJpZM4YePmH.gif" height="1" width="1" alt="" /></p>
<script type="application/json" data-scope="inboxmarkup">{"api_version":"1.0","publisher":{"api_key":"05dde50f1d1a384dd78767c55493e4bb","name":"GitHub"},"entity":{"external_key":"github/bisq-network/bisq","title":"bisq-network/bisq","subtitle":"GitHub repository","main_image_url":"https://assets-cdn.github.com/images/email/message_cards/header.png","avatar_image_url":"https://assets-cdn.github.com/images/email/message_cards/avatar.png","action":{"name":"Open in GitHub","url":"https://github.com/bisq-network/bisq"}},"updates":{"snippets":[{"icon":"DESCRIPTION","message":"Revise contributor / developer docs (#1924)"}],"action":{"name":"View Pull Request","url":"https://github.com/bisq-network/bisq/pull/1924"}}}</script>
<script type="application/ld+json">[
{
"@context": "http://schema.org",
"@type": "EmailMessage",
"potentialAction": {
"@type": "ViewAction",
"target": "https://github.com/bisq-network/bisq/pull/1924",
"url": "https://github.com/bisq-network/bisq/pull/1924",
"name": "View Pull Request"
},
"description": "View this Pull Request on GitHub",
"publisher": {
"@type": "Organization",
"name": "GitHub",
"url": "https://github.com"
}
},
{
"@type": "MessageCard",
"@context": "http://schema.org/extensions",
"hideOriginalBody": "false",
"originator": "AF6C5A86-E920-430C-9C59-A73278B5EFEB",
"title": "Revise contributor / developer docs (#1924)",
"sections": [
{
"text": "",
"activityTitle": "**Chris Beams**",
"activityImage": "https://assets-cdn.github.com/images/email/message_cards/avatar.png",
"activitySubtitle": "@cbeams",
"facts": [

]
},
{
"title": "Commit Summary",
"facts": [
{
"name": "49568c1",
"value": "Rename doc =\u003e docs"
},
{
"name": "c1bcaa6",
"value": "Remove outdated build doc"
},
{
"name": "cbb637a",
"value": "Remove misc/modena.css"
},
{
"name": "5837c28",
"value": "Remove misc/protobuffer_dev_notes.md"
},
{
"name": "efa0ed1",
"value": "Remove misc/ui-development-notes.md"
},
{
"name": "7de30b1",
"value": "Remove scripts/bisq-sn.cron.sh"
},
{
"name": "e84de6d",
"value": "Remove scripts/install_on_unix.sh"
},
{
"name": "08d351f",
"value": "Remove scripts/run_bisq_via_vps.md"
},
{
"name": "8dccf04",
"value": "Move docs/CONTRIBUTING.md =\u003e CONTRIBUTING.md"
},
{
"name": "23a41b6",
"value": "Extract separate docs from main README.md"
},
{
"name": "017a180",
"value": "Rename DEV_SETUP.md =\u003e dev-setup.md"
},
{
"name": "ff6a155",
"value": "Extract dao-setup.md from dev-setup.md"
},
{
"name": "804efd6",
"value": "Rename Bisq_DAO_regtest_setup.zip =\u003e dao-setup.zip"
},
{
"name": "5612889",
"value": "Clean up dao-setup.zip contents"
},
{
"name": "0322dba",
"value": "Revise dev-setup.md"
},
{
"name": "d2050bc",
"value": "Revise dao-setup.md"
},
{
"name": "e0e2da6",
"value": "Overhaul CONTRIBUTING.md"
}
]
},
{
"title": "File Changes",
"facts": [
{
"name": "Modified",
"value": "[CONTRIBUTING.md](https://github.com/bisq-network/bisq/pull/1924/files#diff-0) (86 changes)"
},
{
"name": "Modified",
"value": "[README.md](https://github.com/bisq-network/bisq/pull/1924/files#diff-1) (44 changes)"
},
{
"name": "Removed",
"value": "[doc/Bisq_DAO_regtest_setup.zip](https://github.com/bisq-network/bisq/pull/1924/files#diff-2) (0 changes)"
},
{
"name": "Removed",
"value": "[doc/CONTRIBUTING.md](https://github.com/bisq-network/bisq/pull/1924/files#diff-3) (33 changes)"
},
{
"name": "Removed",
"value": "[doc/DEV_SETUP.md](https://github.com/bisq-network/bisq/pull/1924/files#diff-4) (161 changes)"
},
{
"name": "Removed",
"value": "[doc/misc/modena.css](https://github.com/bisq-network/bisq/pull/1924/files#diff-5) (3617 changes)"
},
{
"name": "Removed",
"value": "[doc/misc/protobuffer_dev_notes.md](https://github.com/bisq-network/bisq/pull/1924/files#diff-6) (246 changes)"
},
{
"name": "Removed",
"value": "[doc/misc/ui-development-notes.md](https://github.com/bisq-network/bisq/pull/1924/files#diff-7) (98 changes)"
},
{
"name": "Removed",
"value": "[doc/outdated/build.md](https://github.com/bisq-network/bisq/pull/1924/files#diff-8) (136 changes)"
},
{
"name": "Removed",
"value": "[doc/scripts/bisq-sn.cron.sh](https://github.com/bisq-network/bisq/pull/1924/files#diff-9) (46 changes)"
},
{
"name": "Removed",
"value": "[doc/scripts/install_on_unix.sh](https://github.com/bisq-network/bisq/pull/1924/files#diff-10) (22 changes)"
},
{
"name": "Removed",
"value": "[doc/scripts/run_bisq_via_vps.md](https://github.com/bisq-network/bisq/pull/1924/files#diff-11) (63 changes)"
},
{
"name": "Added",
"value": "[docs/README.md](https://github.com/bisq-network/bisq/pull/1924/files#diff-12) (9 changes)"
},
{
"name": "Added",
"value": "[docs/build.md](https://github.com/bisq-network/bisq/pull/1924/files#diff-13) (29 changes)"
},
{
"name": "Added",
"value": "[docs/dao-setup.md](https://github.com/bisq-network/bisq/pull/1924/files#diff-14) (83 changes)"
},
{
"name": "Added",
"value": "[docs/dao-setup.zip](https://github.com/bisq-network/bisq/pull/1924/files#diff-15) (0 changes)"
},
{
"name": "Added",
"value": "[docs/dev-setup.md](https://github.com/bisq-network/bisq/pull/1924/files#diff-16) (92 changes)"
},
{
"name": "Added",
"value": "[docs/idea-import.md](https://github.com/bisq-network/bisq/pull/1924/files#diff-17) (17 changes)"
}
]
}
],
"potentialAction": [
{
"name": "Add a comment",
"@type": "ActionCard",
"inputs": [
{
"isMultiLine": true,
"@type": "TextInput",
"id": "IssueComment",
"isRequired": false
}
],
"actions": [
{
"name": "Comment",
"@type": "HttpPOST",
"target": "https://api.github.com",
"body": "{\n\"commandName\": \"IssueComment\",\n\"repositoryFullName\": \"bisq-network/bisq\",\n\"issueId\": 1924,\n\"IssueComment\": \"{{IssueComment.value}}\"\n}"
}
]
},
{
"name": "Close pull request",
"@type": "HttpPOST",
"target": "https://api.github.com",
"body": "{\n\"commandName\": \"PullRequestClose\",\n\"repositoryFullName\": \"bisq-network/bisq\",\n\"pullRequestId\": 1924\n}"
},
{
"targets": [
{
"os": "default",
"uri": "https://github.com/bisq-network/bisq/pull/1924"
}
],
"@type": "OpenUri",
"name": "View on GitHub"
},
{
"targets": [
{
"os": "default",
"uri": "https://github.com/bisq-network/bisq/pull/1924.patch"
}
],
"@type": "OpenUri",
"name": "View patch"
},
{
"targets": [
{
"os": "default",
"uri": "https://github.com/bisq-network/bisq/pull/1924.diff"
}
],
"@type": "OpenUri",
"name": "View diff"
},
{
"name": "Unsubscribe",
"@type": "HttpPOST",
"target": "https://api.github.com",
"body": "{\n\"commandName\": \"MuteNotification\",\n\"threadId\": 410581383\n}"
}
],
"themeColor": "26292E"
}
]</script>