From be4d2347e8372865f53cfcd54fc7495799719b97 Mon Sep 17 00:00:00 2001 From: OniriCorpe Date: Tue, 27 Feb 2024 23:45:31 +0100 Subject: [PATCH] add a note about package documentation in the readme --- README.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 1c49b201..8eb8ccb7 100644 --- a/README.md +++ b/README.md @@ -5,15 +5,19 @@ 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: + # 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 git clone --recursive https://github.com/YunoHost/doc.git ``` - You can refer to the page on [writing documentation](https://yunohost.org/write_documentation). 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: -https://sass-lang.com/guide - +