User-Guide Documentation for Tensei-Data

This repository holds the user guide documentation for Tensei-Data.

The documentation is published available online at: https://tensei-data.github.io/user-guide/

Requirements

The documentation is written using Asciidoctor and the sbt-site plugin.

You will need the following components:

1. Java
2. SBT

Development

The asciidoctor source files need to be placed in the subdirectory doc. They need to have the file extension .adoc. You can edit them with your preferred editor and generate the HTML files via sbt make-site.