Commit Graph

23 Commits

Author SHA1 Message Date
Achilleas Pipinellis
86b6c77337 Update instructions to build guides locally [ci skip]
1. Make clear where rake rdoc is executed
2. Make clear where the generated HTML files for the guides are stored
3. Use bundler 1.3.5 or later
2015-04-28 15:33:13 +03:00
Vipul A M
5cfaf5a46e - Changed IN to ON in markdown renderer condition
- Changed `IN` to `ON` in all note sentences in guides.
2015-01-14 11:52:13 +05:30
Xavier Noria
7702974281 warn about reading guides in GitHub
References #18148.
2014-12-23 23:32:50 +01:00
Dave Powers
95b0e396cc Add link to API Documentation Guidelines
Link to the "English" section to specify American English be used for the Guides
[ci skip]
2014-11-01 18:39:28 -04:00
Robert Eshleman
d71433d7d4 Cleanup Guides Guidelines [ci skip]
* Copy editing for clarity in several locations
* Rename "Titles" section to "Headings"
* Fix incorrect anchor in link to API Documentation Guidelines for filenames
2014-08-10 19:53:00 -04:00
Juanito Fatas
7981f06952 [ci skip] Update GFM link in guides guidelines.
Also remove a duplicated sentence.
2014-05-25 23:36:02 +08:00
Harshad Sabne
eb67aa976b API Documentation Guidelines link correction [ci skip] 2013-11-23 10:45:07 +05:30
Sunny Ripert
666d028bb8 End-of-line whitespace hunt 2013-05-28 14:38:01 +02:00
aditya-kapoor
73fece000f Added instructions of latest bundler install + modified the on: :save option description in validations 2013-04-22 16:16:44 +05:30
Jonathan Roes
d083193c99 Extraneous syntax on guides path. 2013-03-27 23:28:36 -03:00
Vijay Dev
729798068a copy edits [ci skip] 2012-12-08 23:10:38 +05:30
Ian C. Anderson
70b809436f Added overview items to Guides Guidelines prologue 2012-12-07 12:00:48 -05:00
Pablo Torres
1ba6cddf89 List instructions in the order to be executed 2012-12-02 14:28:29 -05:00
Steve Klabnik
d16a1b9e8b Normalize on 'After reading this guide, you will know:'
We have three or four different introduction sentences to the guides.
After this commit, we use the same one everywhere.
2012-11-29 14:25:02 -08:00
Prem Sichanugrist
5e2866cc34 No more Textile guide generation support 2012-09-17 15:55:17 -04:00
Prem Sichanugrist
460c2eec24 Update Guides Guideline for Markdown 2012-09-17 15:54:23 -04:00
Prem Sichanugrist
41dbb58e2d Fix the usage of * in Markdown
In Textile `*` would convert to `<strong>`, but in Markdown we have to
use `**` instead.
2012-09-17 15:54:23 -04:00
Prem Sichanugrist
9873dd800b Convert all the links into Markdown format 2012-09-17 15:54:23 -04:00
Prem Sichanugrist
31ef4cf656 Convert all inline codes to Markdown syntax 2012-09-17 15:54:23 -04:00
Prem Sichanugrist
c89c163a0e Convert inline code tags to Markdown 2012-09-17 15:54:22 -04:00
Prem Sichanugrist
872b7af337 Convert heading tags and heading section 2012-09-17 15:54:22 -04:00
Prem Sichanugrist
7bc1ca3515 Convert code blocks into GFM style 2012-09-17 15:54:22 -04:00
Prem Sichanugrist
5137d03cc5 Rename the rest of the guides to Markdown 2012-09-17 15:54:22 -04:00