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

edit the 'doc/screenshots/' part to reflect ynh/apps#2120

Browse source
This commit is contained in:
OniriCorpe 2024-03-13 03:36:53 +01:00 committed by OniriCorpe
parent 28307c1299
commit 75e44c124a
1 changed files with 4 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
pages/06.contribute/10.packaging_apps/30.doc/doc.md
View file

@ -14,10 +14,13 @@ YunoHost provides several mechanism to display information to users.
You are encouraged to add a `doc/DESCRIPTION.md` which should contain a more extensive description than the short description contained in `manifest.toml`. This usually corresponds to listing the key features of the app. You are encouraged to add a `doc/DESCRIPTION.md` which should contain a more extensive description than the short description contained in `manifest.toml`. This usually corresponds to listing the key features of the app.
You are also encouraged to add a `.png` or `.jpg` screenshot of what the app looks like in `doc/screenshots/`. There is no constrain on the exact filename, but the file weight should be kept below 512kb. You are also encouraged to add a `.png` or `.jpg` screenshot of what the app looks like in `doc/screenshots/`.
The filename is arbitrary but must not start with a dot. Also the file weight should be kept below 512kb.
This description and screenshot will be shown when the admin open the catalog page for this app and the app info page in the webadmin after the admin installs this app. This description and screenshot will be shown when the admin open the catalog page for this app and the app info page in the webadmin after the admin installs this app.
You can add subfolders such as `doc/screenshots/subfolder` to add pictures in your documentation without showing them on the app info page.
You can also add translated versions of the `.md` file in, for example, `doc/DESCRIPTION_fr.md`, `_es.md`, `_it.md`, etc. You can also add translated versions of the `.md` file in, for example, `doc/DESCRIPTION_fr.md`, `_es.md`, `_it.md`, etc.
If your app repository is part of the YunoHost-Apps org, the provided description will be used to auto-regenerate the README.md of your github repo via `yunohost-bot`. If your app repository is part of the YunoHost-Apps org, the provided description will be used to auto-regenerate the README.md of your github repo via `yunohost-bot`.