Documentation is written in the Markdown/CommonMark language using the MarkDig processor for HTML conversion.
The format is compatible with most of the syntax used in e.g. GitHub readme-files.
See the cheat sheet for examples.
For syntax highlighting and previewing Markdown files in Visual Studio use this extension
README.md is the default file name and is used as documentation for the current folder
Visual Studio projects (e.g. modules) should have their documentation placed in a root docs folder.
Documentation for entities or specific files should be given the same name as the file they document and placed in the same folder. E.g. the documentation for a Product.cs file should be named Product.md and placed next to the Product.cs file.
Note that .md files should be marked as Embedded Resource in Visual Studio by right clicking on the file -> Properties -> Build action
Markdown files can be localized by creating multiple files with the same name with the language added after a dash, e.g. README-en.md. The default languge is currently Danish.
Files can be partially or completely marked as internal only (super user only).
Parts of a file are marked as internal by using html tags e.g.
Here is some non-internal content
If the entire content is wrapped in ```` tags then the file will not be accessible nor shown in overviews unless viewed by super users.
Note that HTML tags in Markdown should always have an empty line directly after the opening tag as well as an empty line directly before the closing tag just as the example above.