This guide documents guidelines for writing guides. This guide follows itself in a gracile loop.
endprologue.
h3. Textile
Guides are written in "Textile":http://www.textism.com/tools/textile/. There's comprehensive documentation "here":http://redcloth.org/hobix.com/textile/ and a cheatsheet for markup "here":http://redcloth.org/hobix.com/textile/quick.html.
h3. Prologue
Each guide should start with motivational text at the top. That's the little introduction in the blue area. The prologue should tell the readers what's the guide about, and what will they learn. See for example the "Routing Guide":routing.html.
h3. Titles
The title of every guide uses +h2+, guide sections use +h3+, subsections +h4+, etc.
The guides and the API should be coherent where appropriate. Please have a look at these particular sections of the "API Documentation Guidelines":api_documentation_guidelines.html:
It is also recommended that you work with +WARNINGS=1+, this detects duplicate IDs and warns about broken internal links.
h3. HTML validation
Please do validate the generated HTML with
<plain>
rake validate_guides
</plain>
Particularly, titles get an ID generated from their content and this often leads to duplicates. Please set +WARNINGS=1+ when generating guides to detect them. The warning messages suggest a way to fix them.
h3. Changelog
* October 5, 2010: ported from the docrails wiki and revised by "Xavier Noria":credits.html#fxn