Skip to content

Commit cab8b39

Browse files
committed
docs: Add how write documentation
1 parent 3a3b100 commit cab8b39

File tree

2 files changed

+21
-3
lines changed

2 files changed

+21
-3
lines changed

docs/Developers/Contributing-Services.md renamed to docs/Developers/Contributing.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,24 @@
1-
# Contributing a service to IOTstack
1+
# Contributing
22

3-
On this page you can find information on how to contribute a service to IOTstack. We are generally very accepting of new services where they are useful. Keep in mind that if it is not IOTstack, selfhosted, or automation related we may not approve the PR.
3+
## Writing documentation
4+
5+
Documentation is is written as markdown, processed using mkdocs ([docs](https://www.mkdocs.org/user-guide/writing-your-docs/#writing-your-docs)) and the Material theme ([docs](https://squidfunk.github.io/mkdocs-material/reference/)). The Material theme is not just styling, but provides additional syntax extensions.
6+
7+
Setup your system for Material:
8+
```
9+
pip3 install mkdocs-material
10+
pip3 install mkdocs-git-revision-date-localized-plugin
11+
```
12+
13+
To test your local changes while writing them and before making a pull-request:
14+
```
15+
cd ~/IOTstack
16+
mkdocs serve
17+
```
18+
19+
## Creating a new service
20+
21+
In this section you can find information on how to contribute a service to IOTstack. We are generally very accepting of new services where they are useful. Keep in mind that if it is not IOTstack, selfhosted, or automation related we may not approve the PR.
422

523
Services will grow over time, we may split up the buildstack menu into subsections or create filters to make organising all the services we provide easier to find.
624

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,4 @@ Welcome to the IOTstack Wiki:
1010

1111
* If you are just getting started with IOTstack, see [Getting Started](./Getting-Started.md).
1212

13-
* To contribute see [Contributing Services](Developers/Contributing-Services.md)
13+
* To contribute see [Contributing](Developers/Contributing.md)

0 commit comments

Comments
 (0)