Skip to content

Documentation Structure

The JTE documentation is organized into the following sections: Concepts, Reference, Tutorials, & How-To Guides.

Section Overview

Oriented To Must Form
Concepts understanding explain an article
Reference information describe specifics no-fluff specifications
Tutorials learning help new users get started a hands-on lesson
How-To Guides a goal solve a specific problem a step-by-step walkthrough

Note

Huge shout out to Divio for formalizing this approach here. The previous table comes from the introduction to this documentation system.

Finding What You Need

The MkDocs config file (mkdocs.yml) at the root of the repository defines the page tree for the entire docs site.

The following table outlines where the categories of documentation are stored.

Section Location
Concepts docs/concepts
Reference docs/reference
Tutorials docs/tutorials
How-To Guides docs/how-to
Contributing docs/contributing
Back to top