A/B Street docs

This repo contains the source code (in Markdown format) of the technical documentation and user guides for A/B Street. We use mdbook for formatting, and have a Github action publish on every commit. Contributions to the docs, all of which you can find as .md files in the book/src folder of this repo, and which can be edited on GitHub are very welcome!

To build the book, download or clone the repo, e.g. using the gh CLI as follows:

git clone https://github.com/a-b-street/docs

Then you can change directory and start editing the files, e.g. with the following commands:

cd docs
edit book/src/tech/dev/api.md

That should open an editor with the contents of the api.md open, ready for you to edit. You can also edit the files such as the API documentation linked to above directly in GitHub.

The following commands will serve a locally hosted version of the book from the book folder (assuming you have Rust installed):

cargo install mdbook # install the mdbook crate used to serve the book
cd book
mdbook serve # serve book locally to dynamically update to show your changes

After running the commands above you should see a version of the docs at 127.0.0.1:3000/.

To keep the markdown files formatted the prettier npm package is used. Install it and run the formatting script as follows (on Ubuntu, replace apt with your package manager of choice):

sudo apt install npm
sudo npm install -g prettier
./format_md.sh

After your Pull Request has been accepted you will be able to see the deployed docs at https://a-b-street.github.io/docs.