Confirmed users
564
edits
Platform/GFX/DesignDocumentationGuidelines: Difference between revisions
Platform/GFX/DesignDocumentationGuidelines (view source)
Revision as of 19:16, 11 April 2014
, 11 April 2014→In wiki, blog, random web page, etc.
Msreckovic (talk | contribs) |
Msreckovic (talk | contribs) |
||
| Line 31: | Line 31: | ||
* Sometimes this is necessary, but don't overuse it. Good usage scenarios are blog posts, and such. | * Sometimes this is necessary, but don't overuse it. Good usage scenarios are blog posts, and such. | ||
* The source file should contain a pointer to the documentation, and vice versa. | * The source file should contain a pointer to the documentation, and vice versa. | ||
=== What kind of a bike shed would you like? === | |||
I personally prefer using ====== for level 1 and ------- for level two headers over # and ##: | |||
This is header level 1 | |||
====================== | |||
This is header level 2 | |||
---------------------- | |||
Rather than | |||
# This is header level 1 | |||
## This is header level 2 | |||
but that's just a random preference. | |||
== Results == | == Results == | ||
If we follow the above rules, everything should nicely get extracted to html, for those browsing graphics documentation pages, while also providing in source information for those browsing the source. | If we follow the above rules, everything should nicely get extracted to html, for those browsing graphics documentation pages, while also providing in source information for those browsing the source. | ||