[bisq-network/bisq-docs] [WIP] Expand docs index into a comprehensive table of contents (#60)

Chris Beams notifications at github.com
Wed May 30 10:09:31 UTC 2018


Glad you asked, @ripcurlx. Where a doc doesn't exist yet, and there is _something_ on the website we can link to, we can do that. For example, I would add a link to bisq.network/faq/#altcoins from the word `100+` in the Altcoins entry.

This is all just stopgap stuff, though. The idea is to write an actual `altcoins.adoc` document, and within do an official link to the canonical list of all altcoins, which we may even want to be the `bisq.assets.Assets` provider-configuration file in the bisq-assets repository (so as to avoid the need to duplicating and maintain this frequently-changing list).

Zooming out a bit, I believe the FAQ should simply go away. You'll notice there's no entry for it in the new "User Docs" section of the index, and that is quite intentional. FAQs are often great, especially in the early days of a project, but they can also easily become a kind of "cheap" way out of organizing your project's information in a way that's actually intuitive and helpful. I don't want to make people read through a big list of mostly unstructured questions-and-answers to find what they need. I want to present it to them in a way that's intentionally designed to be pleasant and helpful and appropriate at every step of the way. So you can think of what's happening here in this PR as systematically gutting the FAQ (and many other pages on the current website), transforming them into a well-organized collection of documents that anyone can navigate through get to what they need.

As this process progresses, there will be less and less 'content' on the main site, and this too is intentional. I'd like to see the main bisq.network site become a very simple "brochure" for Bisq; a simple and attractive few pages that show the user what Bisq is and why they should care in an emotionally compelling way, such that they follow the key call to action, which is to _Get Started._ Upon clicking that link, they find themselves in Bisq docs-land, where they can then find everything they need. I believe this approach is well-aligned with @pedromvpg's proposed changes to the website in his design refresh proposal.

How does that sound?

-- 
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/pull/60#issuecomment-393106543
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.bisq.network/pipermail/bisq-github/attachments/20180530/3b547458/attachment-0002.html>


More information about the github mailing list