Introduction

What is this?

This repo is a mockup of the Wasabi wallet repo, built to test what the documentation files would look like if they were brought into a GitBook static website.

Why?

GitBooks are really simple to build and maintain because they mirror the markdown files in a given repository while adding structure to them. The development and vetting process around the documentation stays the same, but the final product is much easier to use and navigate through. Additionally, good looking docs are just rad; they make us want to work harder at making them more complete, more precise, and more user-friendly.

How does it work?

We use GitBook to create a static website from a specific directory called /docs on the master branch of the repo. GitBook then publishes the final product on a public website for free.

I have taken a bunch of the Wasabi wallet documentation markdown files and copied them in a new structure under the /docs directory of a mockup Wasabi repository built just for this purpose. GitBooks simply monitors that repository for changes and builds the documentation website!

The only added requirement are two files called SUMMARY.md and .gitbook.yaml, in which one provides structure for how they want the files to be put together in GitBook; this is how we generate the layout of the table of content on the left, and can of course be changed to fit the project's needs as they evolve. Again, check out the repo that generated this site to get a sense of how it works.

Can I see what it looks like?

Check it out here! But remember that these docs are not exhaustive and are not being kept up-to-date; they really are there just to showcase what could be done.