5643f8f6d2
* Added docs with new screenshots * Added doc to architecture * Added documentations to various extension modules * Added more documentation to modes * Added docs to managers * Added docs for services * Fixed deployment docs * Added white labelling documentation * Added i18n docs and measurement export
48 lines
1.3 KiB
Markdown
48 lines
1.3 KiB
Markdown
# How To: Documentation Step-by-Step
|
|
|
|
We use [GitBook](https://www.gitbook.com/) to create our documentation. It primarily uses markdown, html, css, js, misc. plugins, and configuration to generate high quality, easy to read, and easy to maintain documentation.
|
|
|
|
## Getting Started
|
|
|
|
_Requirements:_
|
|
|
|
Make sure you have the [`gitbook-cli`](https://www.npmjs.com/package/gitbook-cli) installed globally:
|
|
|
|
(Note that gitbook 3.2.3 works with node 10.19.0 and node 10.24.0, but not with node 14.x.)
|
|
> `npm install -g gitbook-cli`
|
|
|
|
### Editing and Previewing Changes
|
|
|
|
Currently, you can only edit and preview a single "book" at a time. We maintain one "book" per API major version. You can find each version's book at:
|
|
|
|
_Past Versions:_
|
|
|
|
- Template:
|
|
- `<project-root>/docs/v<versionNumber>`
|
|
- Examples:
|
|
- `/docs/v1`
|
|
- `/docs/v2`
|
|
|
|
_Latest Version:_
|
|
|
|
The latest version will always be located in `/docs/latest`
|
|
|
|
_Live Preview:_
|
|
|
|
In your terminal / command prompt:
|
|
|
|
```bash
|
|
cd /docs/latest
|
|
gitbook install
|
|
gitbook serve
|
|
```
|
|
|
|
Which should generate output like:
|
|
|
|
> starting server...
|
|
> serving book on http://localhost:4000
|
|
|
|
Navigating to the the provided URL will show a preview of what the generated book should look like. Any edits you make to the book's markdown files should automatically update in your browser.
|
|
|
|
### Publishing
|