[bisq-network/bisq-docs] Migrate Bisq docs to more flexible platform (#131)

Steve Jain notifications at github.com
Wed Sep 11 17:40:16 UTC 2019


I'm experimenting with integrating docs into the website through a Jekyll plugin called [jekyll-asciidoc](https://github.com/asciidoctor/jekyll-asciidoc).

Benefits:
* gain ability to implement features like search, translations, and better navigation
* can continue writing in AsciiDoc
* no need to learn and maintain a new framework (Vuepress, Antara, etc)
* we already maintain a Jekyll site
* harness the traffic and SEO of the main Bisq site

Initial integration content went well. The following remains:
* implementing search (lunr.js looks promising; it accomplishes search by generating an index at build time that's sent to clients and queried right in the browser)
* determining a navigation layout that combines site navigation with docs navigation that's not unwieldy (have mockups)
* having a plan for translations (should be able to use the existing translations mechanism combined with asciidoc attributes)

More importantly, we need to decide if this integration is a good idea from an organizational standpoint, since the website and docs maintainers have historically been different roles, and this integration would effectively put both repositories under the control of one role. 

I want to get other docs done before spending more time on this, so I make this update in search of feedback, with the intention of revisiting it in a month or so to implement.

-- 
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/131#issuecomment-530487168
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.bisq.network/pipermail/bisq-github/attachments/20190911/f0b69c3f/attachment.html>


More information about the bisq-github mailing list