summaryrefslogtreecommitdiff
path: root/doc/contributing/documentation_guide.md
AgeCommit message (Collapse)Author
2025-12-22[DOC] Languages in Examples (#15697)Burdette Lamar
* [DOC] Languages in Examples * Update doc/contributing/documentation_guide.md Co-authored-by: Jeremy Evans <code@jeremyevans.net> * Update doc/contributing/documentation_guide.md Co-authored-by: Jeremy Evans <code@jeremyevans.net> --------- Co-authored-by: Jeremy Evans <code@jeremyevans.net>
2025-07-22Fix typos in `documentation_guide.md`Allison Cretel
2025-07-11[DOC] Fix links to RDoc in documentation_guide.mdPeter Zhu
Since RDoc's documentation is built separately now, the references will no longer work.
2025-01-16[DOC] Link to MarkupReference directlyNobuyoshi Nakada
Notes: Merged: https://github.com/ruby/ruby/pull/12586
2025-01-02[DOC] Exclude 'Class' and 'Module' from RDoc's autolinkingNobuyoshi Nakada
Notes: Merged: https://github.com/ruby/ruby/pull/12496
2024-12-12[DOC] Improve formatting in Markdown files (#12322)Alexander Momchilov
* 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-08-23Adds remarks about returned EnumeratorBurdetteLamar
2024-08-08[DOC] Add remark about in-brief for method docBurdetteLamar
Notes: Merged: https://github.com/ruby/ruby/pull/11330
2024-07-31[DOC] Adds "Further Considerations" to documentation_guide.md (#11281)Burdette Lamar
Notes: Merged-By: peterzhu2118 <peter@peterzhu.ca>
2024-07-29Add remark about call-seqBurdetteLamar
Notes: Merged: https://github.com/ruby/ruby/pull/11261
2024-02-12More on auto-link (#9907)Burdette Lamar
2023-12-02[DOC] More on What's Here (#9099)Burdette Lamar
* More on What's Here * More on What's Here
2023-11-23Add recommendations on link formatting in documentationBurdette Lamar
2023-10-20[DOC] Improve docs for how to generate documentationMatheus Richard
It might not be obvious how to get the build directory and the Makefile set up.
2023-09-24[DOC] Correction for doc guide + TOC fix in File (#8505)Burdette Lamar
2023-08-23[DOC] Adding font usage to doc guide (#8255)Burdette Lamar
Notes: Merged-By: peterzhu2118 <peter@peterzhu.ca>
2023-08-11[DOC] Don't suppress autolinks (#8207)Burdette Lamar
Notes: Merged-By: peterzhu2118 <peter@peterzhu.ca>
2023-06-28[DOC] Fixes for link fragments (#7981)Burdette Lamar
Notes: Merged-By: peterzhu2118 <peter@peterzhu.ca>
2023-03-03[DOC] Add missing word to documentation_guide.mdEzra-Shimon Rosenfeld
Notes: Merged: https://github.com/ruby/ruby/pull/7414
2023-02-19Mention when it is appropriate to document aliases in call-seqJeremy Evans
2023-02-19[DOC] Change to handling of aliases (#7340)Burdette Lamar
Change to handling of aliases Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2022-10-24[DOC] Add note about method names (#6620)Burdette Lamar
Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2022-10-06Adapt doc guide to new GFM features (#6504)Burdette Lamar
* Adapt doc guide to new GFM features * Adapt doc guide to new GFM features Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2022-10-04[DOC] Adding remarks about HTML and tables (#6485)Burdette Lamar
* Adding remarks about HTML and tables Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2022-08-22[DOC] Addition to section 'Related Methods' (#6271)Burdette Lamar
Addition to section 'Related Methods': suggests adding differentiators to the names of related methods. Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2022-07-12[DOC] Revisions for call-seq in doc guidelines (#6121)Burdette Lamar
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. Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2022-05-19[DOC] Re-markup as MarkdownNobuyoshi Nakada
2022-05-11Improve documentation on contributing to RubyJemma Issroff
co-authored-by: Peter Zhu <peter@peterzhu.ca> co-authored-by: Stan Lo <stan001212@gmail.com> Notes: Merged: https://github.com/ruby/ruby/pull/5899