aboutsummaryrefslogtreecommitdiff
path: root/ADMIN.md
blob: 32523c1dd1efc48bf0cde80e336e5036cad7b25d (plain)

Maintenance of feature structure

Writing style of documentation files, coding style of scripts, and how to handle translation, preview, and compilation.

Documentation

Texts are written in CommonMark - a strict flavor of Markdown.

Use [ATX headings][] and semantic linewrapping.

Use reference links (shortcut style where possible), with its reference definition at bottom of same section.

Avoid hard line breaks.

[ATX headings] https://en.wikipedia.org/wiki/Aaron_Swartz#Markdown "ATX headings - header markup using leading hashtags"