4 # Writing documentation for the DALi programming guide {#documentationguide}
6 For documentation, please follow these guidelines:
8 - Create a mark down file (.md) using GitHub Flavoured Markdown https://help.github.com/articles/github-flavored-markdown/
9 - Put it into the following folder: dali-toolkit/docs/content/programming-guide/
10 - Include code samples for C++ in the mark down.
11 - See script-overview.md overview in dali-toolkit/docs/content/programming-guide for an example
12 - For DOXYGEN to link to the mark down it currently needs a reference {hash myfile}
16 Doxygen copies all images in to the same folder as the HTML generated pages so you can just reference it as follows:
19 ![ ](screen-shot.png) // required for Doxygen
21 The space between the brackets is the alternative text. This means you will never see a broken image symbol.
26 Please have a look at the numerous markdown files to see the header and footer requirements.
28 You can add tags to your headings as follows:
30 # MyChapter {#my-chapter}
32 Which will allow you to link to this section as follows:
34 [Go To MyChapter](@ref my-chapter)
37 Code blocks can be enclosed within 2 blocks of 3 tildes(~).
39 You can even specify your language type, for example: