add some documentation structure
This commit is contained in:
parent
51cd583dff
commit
5ca311d240
15 changed files with 168 additions and 2 deletions
16
docs/concepts-and-configurations/documentation-structure.md
Normal file
16
docs/concepts-and-configurations/documentation-structure.md
Normal file
|
|
@ -0,0 +1,16 @@
|
|||
---
|
||||
title: Documentation Structure
|
||||
order: 1
|
||||
summary: >-
|
||||
How our documentation is organized and what we do to balance ease of writing and understanding.
|
||||
---
|
||||
|
||||
!!! info "ToDo"
|
||||
|
||||
This section needs updating
|
||||
|
||||
- Docs should be english
|
||||
- Guides are for step-by-step things
|
||||
- Guides always have a "Goal" explicitly formulated
|
||||
- Concepts and Configuration aim to make readers understand something in detail
|
||||
|
||||
Loading…
Add table
Add a link
Reference in a new issue