5579c5234f
|
||
|---|---|---|
| .. | ||
| src | ||
| .gitignore | ||
| CNAME | ||
| README.md | ||
| mkdocs.yml | ||
README.md
The Nimbus Guide is written using markdown and material for mkdocs.
See the Makefile for setup.
The guide is divided into several sections - broadly:
- Guides - walk-throughs that allow the user to get started with a specific area of the client
- How-to:s - short pages that show the user how to solve a specific problem or perform a specific task
- Reference - pages describing how specific parts of Nimbus work, reference-style
- "Other" - explanations of concepts, background etc.
Resources
- material for mkdocs - doc generator
- divio - useful resource diving into the above section structure