# Rust project template
This project is a template for new Rust projects. It contains up-to-date tooling for tests, docs, versioning, and dependency management.
In a nutshell, the idea is that you clone/fork this project, and then modify it to suit your new project. The [`docs/how-to/getting-started.md`](tutorials/getting-started.md) page provides a step-by-step guide.
## Documentation
To view the documentation, run:
```sh
mkdocs serve
```
and go to [localhost:8000](http://localhost:8000) in your browser.
The documentation provides a detailed guide to the project. It is structured using the [Diátaxis framework](https://diataxis.fr/) to help you navigate and understand the project effectively. This framework consists of 4 categories:
1. **Tutorials**: Guides that teach a concept.
2. **How-To Guides**: Step-by-step instructions to achieve specific goals or tasks.
3. **Reference**: Technical descriptions of the project's components and APIs.
4. **Explanations**: In-depth discussions of concepts and motivations.