Threefold Grid Manual

Requirements

• Make
• mdbook
• mdbook-mermaid
• mdbook-last-changed
• jq
• bc

Make

To properly build and serve the manual, use the make build and make serve commands. This is important since the manual fetches data online through scripts.

Build

Use the following command to build the book:

make build

Serve

Use the following command to serve the book (this will open the browser)

make serve

Browse docs

• The official ThreeFold manual is available at www.manual.grid.tf
• Staging version from development branch is available at www2.manual.grid.tf
• Staging version from development-split branch is available at wwww3.manual.grid.tf

Contribute

If you want to contribute to Manual.grid.tf, you should follow this steps:

1. Add the md file to src directory.
2. Add the path of the md file to SUMMARY.
3. Then use make build and make serve to see your changes on the browser.

Read the section How to Contribute for more information.