summaryrefslogtreecommitdiff
path: root/doc/contributing
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-11-27Reorganize page documentations (#15154)Stan Lo
Re-organize page docs
2025-11-18[DOC] Add documentation about Ruby's VM stackStan Lo
2025-11-05[DOC] Update glossary (#15070)Randy Stauner
2025-10-20[DOC] Create doc/contributing/concurrency_guide.mdLuke Gruber
This guide is for those that want to contribute to ruby but don't understand where they need to use locks or other concurrency mechanisms. It teaches them how to use these locks safely and what is prohibited in certain circumstances.
2025-10-15[DOC] Update making_changes_to_stdlibs.md mirror ExampleMarino Bonetti
CSV is no more part of the standard lib, but the documentation was not updated (the example link was broken for the master branch) Selected ERB that has the dedicated directory, like CSV.
2025-10-09[DOC] Update required baseruby versionNobuyoshi Nakada
2025-09-22[DOC] Add `snt` and `dnt` to glossary.mdLuke Gruber
2025-07-29[DOC] Remove point about ASAN not working on released RubyPeter Zhu
ASAN works on Ruby 3.4 and later, so we can remove the point about using master branch for ASAN.
2025-07-22Fix typos in `documentation_guide.md`Allison Cretel
2025-07-22Change `TESTOPS` to `TESTOPTS`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-07-11[DOC] Add ZJIT glossary tableStan Lo
2025-07-11[DOC] Add a few new terms to Ruby glossaryStan Lo
2025-06-05More comprehensive debugging configurationÉtienne Barrié
2025-04-18Mention VS Code debugger configuration in debugging guideStan Lo
Notes: Merged: https://github.com/ruby/ruby/pull/13129
2025-03-31[DOC] Tweaks for docs about contributing (#13012)Burdette Lamar
Notes: Merged-By: peterzhu2118 <peter@peterzhu.ca>
2025-01-31- Add a mention to git 2.32 in the building ruby documentation:Edouard CHIN
I had issues building Ruby as I was using git 2.30. The error was: > file2lastrev.rb: git rev-parse failed error: could not expand > include path '~/.gitcinclude' The default system git config includes paths making use of `$HOME`, but that env variable gets removed when building: https://github.com/ruby/ruby/blob/7070b1b1968f31f999636b42a1af872458cd5a81/tool/lib/vcs.rb#L546-L547 It works with git `>= 2.32` thanks to the `GIT_CONFIG_SYSTEM` feature which gets set to a Null IO in order to override the system gitconfig. https://github.com/ruby/ruby/blob/7070b1b1968f31f999636b42a1af872458cd5a81/tool/lib/vcs.rb#L549 Notes: Merged: https://github.com/ruby/ruby/pull/12611
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-12Improve "Building Ruby" docs (#12320)Alexander Momchilov
* Clarify “Building Ruby” docs * Fix test examples to work from `build` dir * Clarify “Testing Ruby” examples with real examples All the commands should run correctly by default, without the user needing to modify them. This builds confidence that the relative paths are working correct from within the `build` directory. Also, let’s use a consistent example throughout, for greater clarity. * Improve examples to use `-v` flag in-context This shows the correct way to combine `-v` with another parameter, e.g. a specific file to test. * Other readability improvements * Clarify `make` implementation support
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-11-12[DOC] `--with-opt-dir` options and `CONFIGURE_ARGS`Nobuyoshi Nakada
Notes: Merged: https://github.com/ruby/ruby/pull/12059
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-07-07[DOC] Fix typo `with` -> `wish`cdfzo
2024-06-02[DOC] building_ruby: Move the caution to a footnoteNobuyoshi Nakada
2024-06-02[DOC] building_ruby: External library linksNobuyoshi Nakada
- `OpenSSL` here is not the class. - libexecinfo on FreeBSD is present in the base system of all supported releases, since 2017.
2024-06-02[DOC] building_ruby: Refine linksNobuyoshi Nakada
Get rid of using ambiguous demonstratives as link anchors, for the accessibility's sake.
2024-06-02[DOC] building_ruby: Fold long linesNobuyoshi Nakada
2024-06-02[DOC] Caution about old GNU makeNobuyoshi Nakada
2024-05-10Update ASAN docs to refer to Clang 18's releaseKJ Tsanaktsidis
Clang 18 has the bugfix we need, so we no longer need to tell people to compile Clang from source.
2024-04-24Removed obsoleted section because make docs is removed from default make taskHiroshi SHIBATA
2024-04-17Update build and install document related ↵Hiroshi SHIBATA
https://blade.ruby-lang.org/ruby-dev/39325
2024-03-31Document how to run the tests under ASAN now that they pass!KJ Tsanaktsidis
2024-02-26BASERUBY is now >= 3.0John Hawthorn
2024-02-15s/bellow/below/ydah
2024-02-13Fix typo in asan section of building_ruby.md docsKJ Tsanaktsidis
s/copmiler-rt/compiler-rt/
2024-02-12More on auto-link (#9907)Burdette Lamar
2024-02-12Update ASAN docs to reflect the current state of thingsKJ Tsanaktsidis
I don't really think ASAN works well at all on any version of Ruby from before https://bugs.ruby-lang.org/issues/20001 was landed. Update the docs to clarify what works, and what does not work. Also there's no need to compile at `-O0`; this was probably just hiding some of the problems with our stack scanning that were fixed in the above issue. [Bug #20248]
2024-01-18[DOC] Update ruby version in Building Ruby DependenciesKazuhiro NISHIYAMA
2023-12-25Typofix under doc directoryHiroshi SHIBATA
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-11-06[DOC] Use a relative link like other linksTakashi Kokubun
following up on https://github.com/ruby/ruby/pull/8832
2023-11-06Updated building_ruby.md to include reference for building on WindowsJorandeBoer
Looking at building_ruby.md it is unclear that you are able to build Ruby on Windows. To fix that a reference has been added to the windows.md file.
2023-10-20[DOC] `configure -C` tipsNobuyoshi Nakada
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.