Holger Frey
2 years ago
10 changed files with 112 additions and 5 deletions
@ -0,0 +1,18 @@ |
|||||||
|
# Explanation |
||||||
|
|
||||||
|
This part of the project documentation focuses on a |
||||||
|
**learning-oriented** approach. You'll learn how to |
||||||
|
get started with the code in this project. |
||||||
|
|
||||||
|
> **Note:** Expand this section by considering the |
||||||
|
> following points: |
||||||
|
|
||||||
|
- Help newcomers with getting started |
||||||
|
- Teach readers about your library by making them |
||||||
|
write code |
||||||
|
- Inspire confidence through examples that work for |
||||||
|
everyone, repeatably |
||||||
|
- Give readers an immediate sense of achievement |
||||||
|
- Show concrete examples, no abstractions |
||||||
|
- Provide the minimum necessary explanation |
||||||
|
- Avoid any distractions |
@ -0,0 +1,6 @@ |
|||||||
|
# How-To Guides |
||||||
|
|
||||||
|
This part of the project documentation focuses on a |
||||||
|
**problem-oriented** approach. You'll tackle common |
||||||
|
tasks that you might have, with the help of the code |
||||||
|
provided in this project. |
@ -0,0 +1,20 @@ |
|||||||
|
# SensoSpot Tools Documentation |
||||||
|
|
||||||
|
This site contains the project documentation for the |
||||||
|
`sensospot_tools` project. |
||||||
|
|
||||||
|
|
||||||
|
## Table Of Contents |
||||||
|
|
||||||
|
The documentation follows the best practice for |
||||||
|
project documentation as described by Daniele Procida |
||||||
|
in the [Diátaxis documentation framework](https://diataxis.fr/) |
||||||
|
and consists of four separate parts: |
||||||
|
|
||||||
|
1. [Tutorials](tutorials.md) |
||||||
|
2. [How-To Guides](how-to-guides.md) |
||||||
|
3. [Reference](reference.md) |
||||||
|
4. [Explanation](explanation.md) |
||||||
|
|
||||||
|
Quickly find what you're looking for depending on |
||||||
|
your use case by looking at the different pages. |
@ -0,0 +1,11 @@ |
|||||||
|
# Reference |
||||||
|
|
||||||
|
This part of the project documentation focuses on |
||||||
|
an **information-oriented** approach. Use it as a |
||||||
|
reference for the technical implementation of the |
||||||
|
`sensospot_tools` project code. |
||||||
|
|
||||||
|
|
||||||
|
::: sensospot_tools.hdr |
||||||
|
|
||||||
|
::: sensospot_tools.selection |
@ -0,0 +1,17 @@ |
|||||||
|
# Tutorials |
||||||
|
|
||||||
|
This part of the project documentation focuses on an |
||||||
|
**understanding-oriented** approach. You'll get a |
||||||
|
chance to read about the background of the project, |
||||||
|
as well as reasoning about how it was implemented. |
||||||
|
|
||||||
|
> **Note:** Expand this section by considering the |
||||||
|
> following points: |
||||||
|
|
||||||
|
- Give context and background on your library |
||||||
|
- Explain why you created it |
||||||
|
- Provide multiple examples and approaches of how |
||||||
|
to work with it |
||||||
|
- Help the reader make connections |
||||||
|
- Avoid writing instructions or technical descriptions |
||||||
|
here |
@ -0,0 +1,17 @@ |
|||||||
|
site_name: Sensospot Tools Docs |
||||||
|
|
||||||
|
nav: |
||||||
|
- Introduction: index.md |
||||||
|
- Tutorials: tutorials.md |
||||||
|
- How-To Guides: how-to-guides.md |
||||||
|
- Reference: reference.md |
||||||
|
- Explanation: explanation.md |
||||||
|
|
||||||
|
repo_url: https://github.com/example/repository/ |
||||||
|
|
||||||
|
theme: |
||||||
|
name: readthedocs |
||||||
|
highlightjs: true |
||||||
|
|
||||||
|
plugins: |
||||||
|
- mkdocstrings |
Loading…
Reference in new issue