[bisq-network/bisq-docs] old documentation ? (#68)

Chris Beams notifications at github.com
Wed Jun 6 10:08:00 UTC 2018


It would be fine to, at a minumum, add links to all existing docs in their current locations to the Archive section of docs.bisq.network. I don't want to put any of them front and center, though, as they are all quite old, have varying quality of writing style and formatting, etc. Generally, we want updated versions of these docs everywhere, and not just transcribed / touched-up versions. So adding links to the archive is great, but let's not bother with transcribing them into asciidoc, etc. Please double-check also that the docs in question haven't already been transcribed in the `exchange` folder under the bisq-network/bisq-docs repository. Pull requests welcome.

As an aside, please also study how titles of issues are usually created here in bisq-network GitHub repositories. Rather than:

> old documentation ?

it would be better to title the issue something like:

> Add links to old documentation

Generally, form issues as imperative statements rather than questions. Use conventional sentence capitalization, avoid punctuation at statement end.

If you do create a pull request to add these links to the archive, please reference this issue in the pull request description by mentioning #68. You can use the keyword "Fixes", e.g. "Fixes #68" in the description of the pull request, and that will cause this issue to be closed automatically if and when the pull request is merged. See https://help.github.com/articles/closing-issues-using-keywords/ for details.

-- 
You are receiving this because you are subscribed to this thread.
Reply to this email directly or view it on GitHub:
https://github.com/bisq-network/bisq-docs/issues/68#issuecomment-395017281
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.bisq.network/pipermail/bisq-github/attachments/20180606/d1b249a9/attachment.html>


More information about the bisq-github mailing list