VSinerva/freesewing
1
0
Fork 0
Code Activity

chore: More linting

Browse source 
@nicholasdower is smarter than me. What's missing was the
`listItemIndent` setting
This commit is contained in:
Joost De Cock 2022-02-20 14:44:38 +01:00
parent e6f1189017
commit 249f2600e5
293 changed files with 2170 additions and 2169 deletions
Download patch file Download diff file Expand all files Collapse all files

18
markdown/dev/guides/docs/en.md
View file

@ -10,10 +10,10 @@ documentation can help you find your feet, and figure out what goes where.
Our documentation is divided into four different types:
- [**Tutorials**](/tutorials) are lessons that lead you through a series of steps to complete a project.
- [**Guides**](/guides) tell a story to further your understanding of a specific topic.
- [**Howtos**](/howtos) give you concrete steps to solve a common problem or challenge.
- [**Reference**](/reference) holds technical descriptions of the underlying technology and how to make use of it.
- [**Tutorials**](/tutorials) are lessons that lead you through a series of steps to complete a project.
- [**Guides**](/guides) tell a story to further your understanding of a specific topic.
- [**Howtos**](/howtos) give you concrete steps to solve a common problem or challenge.
- [**Reference**](/reference) holds technical descriptions of the underlying technology and how to make use of it.
Each time you write documentation, you have to ask yourself: Is it a tutorial? Is it a Guide?
Is it a Howto? Or is it Reference documentation.
@ -24,11 +24,11 @@ where your documentation should go based on what it's trying to accomplish:
![A graphic showing a visual representation of our documentation
structure](docs.png "A visual representation of how our documentation is structured")
- Write a **Tutorial** is your aim is to help people learn the platform
- Write a **Guide** if your aim is to further people's understanding of a topic by going a bit deeper
- Write a **Howto** if your ain is to help people accomplish a task
- Write **Reference** documentation to detail how things work under the hood
- Refer people to **Discord or Github** for things that are not (yet) covered in our documentation
- Write a **Tutorial** is your aim is to help people learn the platform
- Write a **Guide** if your aim is to further people's understanding of a topic by going a bit deeper
- Write a **Howto** if your ain is to help people accomplish a task
- Write **Reference** documentation to detail how things work under the hood
- Refer people to **Discord or Github** for things that are not (yet) covered in our documentation
<Note>