Confirmed users
564
edits
Platform/GFX/DesignDocumentationGuidelines: Difference between revisions
Platform/GFX/DesignDocumentationGuidelines (view source)
Revision as of 21:30, 10 April 2014
, 10 April 2014→In a separate file in the gfx/docs directory
Msreckovic (talk | contribs) (→How) |
Msreckovic (talk | contribs) |
||
| Line 20: | Line 20: | ||
=== In a separate file in the gfx/docs directory === | === In a separate file in the gfx/docs directory === | ||
* Name the documentation file appropriately | * Name the documentation file appropriately | ||
* Use the markdown syntax | * Use the markdown syntax and .md extension for the file (unless you have a really good reason not to) | ||
* The source file should contain a pointer to the documentation, and vice versa. Use the markdown syntax. | * The source file should contain a pointer to the documentation, and vice versa. Use the markdown syntax. | ||
* Good because: | * Good because: | ||