Allison Cretel
45e65f55bc
Fix typos in documentation_guide.md
2025-07-22 12:52:45 -04:00
Peter Zhu
c592cbd616
[DOC] Fix links to RDoc in documentation_guide.md
...
Since RDoc's documentation is built separately now, the references will
no longer work.
2025-07-11 14:07:10 -04:00
Nobuyoshi Nakada
32cb4b204d
[DOC] Link to MarkupReference directly
2025-01-16 14:03:45 +09:00
Nobuyoshi Nakada
e433e6515e
[DOC] Exclude 'Class' and 'Module' from RDoc's autolinking
2025-01-02 12:36:06 +09:00
Alexander Momchilov
0ea5c13bc6
[DOC] Improve formatting in Markdown files ( #12322 )
...
* Fix WASM bullet/code indentation
* Use `console` code highlighting where appropriate
… which handles the prefix `$` correctly.
* Migrate feature proposal template to MarkDown
* Set language on code blocks
2024-12-12 17:49:45 -08:00
BurdetteLamar
b9902c94a3
Adds remarks about returned Enumerator
2024-08-23 16:21:40 -04:00
BurdetteLamar
e008f0553d
[DOC] Add remark about in-brief for method doc
2024-08-08 16:08:47 -04:00
Burdette Lamar
f5d193d525
[DOC] Adds "Further Considerations" to documentation_guide.md ( #11281 )
2024-07-31 16:09:15 -04:00
BurdetteLamar
df1cc04301
Add remark about call-seq
2024-07-29 09:15:19 -04:00
Burdette Lamar
4f1a466522
More on auto-link ( #9907 )
2024-02-12 15:01:46 -05:00
Burdette Lamar
715cf9b690
[DOC] More on What's Here ( #9099 )
...
* More on What's Here
* More on What's Here
2023-12-02 11:46:57 -06:00
Burdette Lamar
12f4e9655e
Add recommendations on link formatting in documentation
2023-11-23 20:39:24 -08:00
Matheus Richard
72f97ee06e
[DOC] Improve docs for how to generate documentation
...
It might not be obvious how to get the build directory and the Makefile
set up.
2023-10-20 08:45:07 +09:00
Burdette Lamar
36cd2b2a52
[DOC] Correction for doc guide + TOC fix in File ( #8505 )
2023-09-24 17:57:21 -04:00
Burdette Lamar
448ff162c4
[DOC] Adding font usage to doc guide ( #8255 )
2023-08-23 10:09:24 -04:00
Burdette Lamar
6ccc660d85
[DOC] Don't suppress autolinks ( #8207 )
2023-08-11 17:53:53 -04:00
Burdette Lamar
6528cf9fcf
[DOC] Fixes for link fragments ( #7981 )
2023-06-28 09:05:43 -04:00
Ezra-Shimon Rosenfeld
ddd3c92bf6
[DOC] Add missing word to documentation_guide.md
2023-03-03 09:40:40 +09:00
Jeremy Evans
59f7bf96d6
Mention when it is appropriate to document aliases in call-seq
2023-02-19 11:58:00 -08:00
Burdette Lamar
ea50765926
[DOC] Change to handling of aliases ( #7340 )
...
Change to handling of aliases
2023-02-19 13:41:32 -06:00
Burdette Lamar
bcb72f503c
[DOC] Add note about method names ( #6620 )
2022-10-24 08:56:13 -05:00
Burdette Lamar
7837dccb0e
Adapt doc guide to new GFM features ( #6504 )
...
* Adapt doc guide to new GFM features
* Adapt doc guide to new GFM features
2022-10-06 15:02:37 -05:00
Burdette Lamar
5fc68e1101
[DOC] Adding remarks about HTML and tables ( #6485 )
...
* Adding remarks about HTML and tables
2022-10-04 13:50:33 -05:00
Burdette Lamar
aeac8b6c3a
[DOC] Addition to section 'Related Methods' ( #6271 )
...
Addition to section 'Related Methods': suggests adding differentiators to the names of related methods.
2022-08-22 13:17:05 -05:00
Burdette Lamar
e3a988a29c
[DOC] Revisions for call-seq in doc guidelines ( #6121 )
...
Splits certain guidelines for singleton and instance method.
Calls for instance method to not prefix anything (like RDoc itself for a Ruby-coded instance method); e.g.:
count -> integer, not array.count,.
<=> other -> integer or nil, not hash <=> other -> integer or nil.
Groups previous guidelines into Arguments, Block, Return types, Aliases.
2022-07-12 20:49:24 -05:00
Nobuyoshi Nakada
61a54d5180
[DOC] Re-markup as Markdown
2022-05-19 17:07:56 +09:00
Jemma Issroff
c00feffb46
Improve documentation on contributing to Ruby
...
co-authored-by: Peter Zhu <peter@peterzhu.ca>
co-authored-by: Stan Lo <stan001212@gmail.com>
2022-05-11 10:59:24 -04:00
