TEST_CODEOWNERS/rails
3
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity
51,106 Commits 2 Branches 0 Tags 294 MiB
c5ee5cf582
Commit Graph

42 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
Nishant Modak
da5ac71885 correct markdown usage [ci skip] 2014-07-09 01:32:44 +05:30
Zachary Scott
cc255d3424 Copy edits from e0f3f1a [ci skip] 
- image_tag is an instance method
- explain possible results when asset pipeline is used
 2014-06-13 11:38:02 -07:00
Zachary Scott
e0f3f1a565 Document behavior concerns regarding the full Rails stack [ci skip] 
Related to a discussion on #15508
 2014-06-13 10:40:53 -07:00
Zachary Scott
f12d6367ad Add links to RDoc back into API documentation guidelines [ci skip] 
These were removed from #15542 unfortunately :(
 2014-06-13 10:10:43 -07:00
Vijay Dev
a39c88b5c9 copy edits [ci skip] 2014-06-07 10:53:25 +00:00
Gaurav Sharma
19ef270923 remove rubyforge.org that was shut down [ci skip] 2014-06-06 22:26:56 +05:30
John Kelly Ferguson
d02c810e29 Rename Posts to Articles in Guides, continuation of 2d446e77 / #13774 [ci skip] 2014-05-21 23:01:45 -04:00
Vijay Dev
ddf32daed8 copy edits[ci skip] 2014-05-18 16:01:31 +00:00
Zachary Scott
7caf3ffffd Document method visibility for designing API docs. [ci skip] 
cc https://github.com/rails/rails/issues/14848#issuecomment-41198795
 2014-05-17 16:11:33 -03:00
Vijay Dev
13e8c80363 prefer file name instead of filename [ci skip] 2014-05-17 08:58:22 +00:00
Zachary Scott
5c3eda874f Add tip about using RDoc's --pipe command to quickly test the output of 
a piece of documentation.

This can be useful for trying out combinations of markup and code, as
discussed in rails/rails@225bcad
 2014-02-10 23:29:33 -08:00
Vijay Dev
92fdd65162 Merge branch 'master' of github.com:rails/docrails 
Conflicts:
	guides/source/active_record_validations.md
	guides/source/api_documentation_guidelines.md
	guides/source/configuring.md
 2014-02-09 23:33:55 +05:30
Zachary Scott
ae7580ac28 Fixed a grammatical error in Booleans section of API documentation guide 
from e1e17a5
 2014-02-09 12:30:00 +01:00
Xavier Noria
7afd92e60b adds a section about booleans in the API guidelines [ci skip] 2014-02-09 12:29:45 +01:00
Xavier Noria
e1e17a55d2 adds a section about booleans in the API guidelines [ci skip] 2014-01-26 22:10:05 +01:00
Xavier Noria
225bcadfed API guidelines: revises warning about +...+ [ci skip] 
Modern RDoc accepts a few more things in +...+. In particular symbols work now.

The current regexp in RDoc is https://github.com/rdoc/rdoc/blob/v4.1.1/lib/rdoc/markup/attribute_manager.rb#L133.
 2014-01-26 21:36:17 +01:00
Vijay Dev
a3b1105ada Merge branch 'master' of github.com:lifo/docrails 2013-12-20 00:10:30 +05:30
Xavier Noria
a176bd095c docs guidelines: recommends wording in a way that avoids "you"s and "your"s 2013-12-12 21:48:33 +01:00
Robin Dupret
fe077b50c9 Remove an extra period 
As a side not, the period after etc is not always
needed http://en.wiktionary.org/wiki/etc
 2013-12-04 20:19:10 +01:00
Guillermo Iguaran
98af6596a9 Add examples for gender neutral pronouns 2013-12-01 23:40:17 -05:00
Guillermo Iguaran
6f0fb7ba25 Update API docs guidelines with reference about gender neutral pronouns 2013-12-01 23:33:54 -05:00
Xavier Noria
b77f25cb84 cleans the guides sources from fancy non-ASCII stuff 2013-08-23 17:59:11 +02:00
Sunny Ripert
53607be559 Remove double spaces in guides 2013-05-28 14:38:02 +02:00
Sunny Ripert
666d028bb8 End-of-line whitespace hunt 2013-05-28 14:38:01 +02:00
Vijay Dev
729798068a copy edits [ci skip] 2012-12-08 23:10:38 +05:30
Steve Klabnik
aa1b9037bf Fill out API Documentation Guidelines 'you will learn' list. 2012-12-07 23:31:17 -08: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
burningTyger
46100f0ccb make comments fit the comment boxes (mostly) in API doc guides 2012-11-10 22:18:18 +01:00
Rafael Mendonça França
9eeb00976d Revert "divided into folder with the language" 
This reverts commit f5b9ed4fbc3215a5fce48985ea372ad3f1182252.

REASON: Translation work can not be done in the docrails repository
 2012-10-17 10:15:55 -03:00
Rodrigo Martins
f5b9ed4fbc divided into folder with the language 2012-10-17 03:34:10 -03:00
AvnerCohen
a2c8438854 1.9 hash syntax changes. 2012-10-12 00:28:47 +02: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
721afdcc4b Fix remaining formatting problems in the guide 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