[bisq-network/roles] Docs Maintainer (#29)

Chris Beams notifications at github.com
Thu May 3 11:50:00 UTC 2018


## 2018.04 report

Big changes to docs this month!

 - @cbeams created new [docs.bisq.network](https://docs.bisq.network) site and published existing documentation there
   - https://github.com/bisq-network/bisq-docs/pull/36
 - @cbeams produced [Intro to Bisq](https://docs.bisq.network/intro.html) doc
 - @cbeams produced [New Contributor Checklist](https://docs.bisq.network/contributor-checklist.html) doc
   - https://github.com/bisq-network/bisq-docs/pull/39
 - @cbeams produced [Proposals](https://docs.bisq.network/proposals.html) doc
   - https://github.com/bisq-network/bisq-docs/pull/40

These changes were promoted via Twitter to good effect.

Also, @m52go has gotten involved, and is in progress producting a Getting Started with Bisq document at https://github.com/bisq-network/bisq-docs/issues/37.

In general, all @bisq-network/contributors are encouraged to get familiar with the new docs site, and to begin thinking about it as *the* place to document all the most important things about Bisq.

When we talk about what it means to [deliver](https://github.com/bisq-network/proposals/issues/19) a contribution, we should always be asking ourselves the question, what needs to change or get added to the documentation such that users can discover and understand my contribution?

The docs site is primitive today. You can think of it as something like "a wiki that wants to become a full-fledged manual". For right now, everything is flat. If there is something you want or need to document, come chat about it in `#bisq-docs`, and then put together a pull request for it, just like any other under.

>From a visual design perspective, the new docs site will be one of the things we want to get aligned with the new design vision coming together with @pedromvpg, @diogorsergio and others. This should be relatively low-hanging fruit, is its' mostly about adapting the existing default Asciidoctor CSS and fonts to align with the new design. This is something I've helped do in previous teams and I can point to that work for a reference point on how to do it.

Questions and ideas welcome about this new infrastructure. Let's chat in `#bisq-docs` in slack.

/cc bisq-network/compensation#68

-- 
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/roles/issues/29#issuecomment-386269299
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.bisq.network/pipermail/github/attachments/20180503/b38ad598/attachment-0001.html>


More information about the github mailing list