Documentation

Overview

This site uses MkDocs to build its documentation and GitHub Pages for hosting.

Information on using MkDocs can be found within the repository's README at the root of the repository, which includes instructions for how to set up MkDocs locally and build the documentation. The README also provides details on how the documentation gets deployed to GitHub Pages via GitHub Actions, and how to run the documentation build locally to test that it builds correctly.

Documentation Structure

The documentation here (/docs) is used to provide more detailed information on the project. It should help engineers / users of the library to understand the implementation choices made, and understand further context around the project and its development.

On the other hand, the README at the root of the repository should provide a high-level overview of the project, and include instructions for how to use the library, how to contribute to the project, and how to set up the development environment.

This pattern adheres to KEH's recommended documentation patterns for repositories.

Think: The README is the "front door" to the repository, providing a clear and concise overview of the project and how to get started with it. The documentation in /docs is the "library" of information that users can refer to for more detailed information on specific topics related to the project.