diff --git a/Workflow for documentation production in OSM.md b/Workflow for documentation production in OSM.md index 724fed3cbb60289906a53f9c04d523be1613b930..7ea87714b0ae12008748a8c704bb5933fa305f65 100644 --- a/Workflow for documentation production in OSM.md +++ b/Workflow for documentation production in OSM.md @@ -309,6 +309,7 @@ It is highly advisable that the editor provides a base file structure for the do - Different chapters (i.e. level-1 titles, with a single dash, **`#`**) of the document should be in different markdown files. Likewise, no more than one level-1 title should be placed in the same file. - Use **`TODO:`** as tag (including the colon, **`:`**) to indicate (in free text) the content expected for a specific section or any pending refinements to be added at later stages. This text will be visible by readers and will be rendered to output formats, so editors should use it wisely to provide sufficient context about the missing content without adding excessive noise to the reader. + - It is highly recommended that all markdown documents end with an empty line, so that the build process is trivial for `pandoc`. - Images should be placed in a dedicated folder. The recommendation is using the `./assets` folder. - Likewise, DOCX templates, auxiliary files, output files, etc. should be placed in dedicated folders - File and folder names should not contain spaces or any other kind of special characters to maximize portability and minimize rendering or reading errors in various auxiliary tools. To improve readability, an useful convention is using dashes (`-`) to replace spaces.