YunoHost/doc
1
0
Fork 0
mirror of https://github.com/YunoHost/doc.git synced 2024-09-03 20:06:26 +02:00
Code Issues Projects Releases Packages Wiki Activity

add a note about package documentation in the readme

Browse source
This commit is contained in:
OniriCorpe 2024-02-27 23:45:31 +01:00
parent 6538f0d4ea
commit be4d2347e8
1 changed files with 7 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -5,15 +5,19 @@
Please report [issues on YunoHost bugtracker](https://github.com/YunoHost/issues/issues). Please report [issues on YunoHost bugtracker](https://github.com/YunoHost/issues/issues).
## Note about package documentation
Package documentation should be done in the package repository itself, under the `/doc` folder.
You can learn about it here: <https://yunohost.org/packaging_app_doc>
# Contributing # Contributing
This repo use a **submodule** to provide the theme. So when you clone use: This repo use a **submodule** to provide the theme. So when you clone use:
```shell ```shell
git clone --recursive https://github.com/YunoHost/doc.git git clone --recursive https://github.com/YunoHost/doc.git
``` ```
You can refer to the page on [writing documentation](https://yunohost.org/write_documentation). You can refer to the page on [writing documentation](https://yunohost.org/write_documentation).
If you know docker, you can run: If you know docker, you can run:
@ -35,5 +39,4 @@ Finally you can rebuild the CSS with (You can replace `expanded` by `compressed`
``` ```
Source: Source:
https://sass-lang.com/guide <https://sass-lang.com/guide>