How-to guides

Description page with images

If the server project folder contains a README.md, the build puts it into the package's wwwroot/readme/ folder, together with the contents of the docs/ folder. The Komod store website shows it on the Komod's page, the KOFA application on the Komod store card (Description button).

Acme.Demo.Thermostat/
  README.md           Markdown: headings, lists, tables, code blocks, links, images
  docs/screen.png     the README references it as ![Tile](docs/screen.png)

Rules

• Images: png, jpg, gif, webp, only from the docs/ folder, with a relative path. An external (https://) image is also allowed.
• Security: raw HTML is not passed through, it is shown as escaped text. A link can only be http(s) or mailto, and opens in a new tab.
• Size: the README.md is at most 256 KB.
• Compatibility: the description is under wwwroot/, so an older KOFA server also installs the package. For a package without a description nothing changes.

What to write in it

On the store page this is the first thing the user sees: what the Komod is for, a table of ports (id, direction, type, meaning), the settings, a wiring example, and for hardware the wiring diagram. The template's README.md gives the skeleton.

The Komod's category comes from the [Komod(Category = KomodCategory.X)] attribute; the store filters by it.