Create documentation - SynoCommunity/spksrc GitHub Wiki

SPKs can have a help integrated with DSM. This is the place to guide the user to use the package, step by steps through main topics like:

• Installation
• Configuration
• Basic Usage
• Feature 1
• Feature 2

Help files are just HTML pages. There's one main page and then sub pages. You can see that into Help in DSM. Debian-Chroot is the first SPK with help pages. It has one main page with Installation, Configuration and Usage topics. Then one page that explains the Service feature.

To contribute, you can check the example of Debian Chroot and produce those HTML files. Please use the same HTML markup as there is in thoose files. Synology uses thoses and special CSS style is applied so it looks nice.

Once you're done with creating the help files, open an issue in SPKSRC with a link to download those help files.