docs(ruby): remove experimental language for precompiled binaries#8073
docs(ruby): remove experimental language for precompiled binaries#8073
Conversation
Summary of ChangesHello @jdx, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request updates the Ruby language documentation to reflect the stable status of precompiled Ruby binaries. It removes all mentions of the 'experimental' flag and badge associated with this feature, streamlining the instructions for users and indicating that this method of installation is now fully supported. Highlights
Changelog
Activity
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Pull request overview
Removes outdated “experimental” wording/requirements from the Ruby docs now that precompiled Ruby binaries are considered stable.
Changes:
- Removes the “experimental” badge from the “Precompiled Binaries” section heading
- Removes the requirement/instruction to enable
experimental = truebefore using precompiled binaries
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ## Precompiled Binaries | ||
|
|
||
| With `experimental = true` enabled, mise can download precompiled Ruby binaries instead of | ||
| Mise can download precompiled Ruby binaries instead of |
There was a problem hiding this comment.
The docs use inconsistent casing for the tool name ('mise' earlier vs 'Mise' here). For consistency across the doc, use the same casing as the project’s standard (typically 'mise' as used elsewhere in this file).
| Mise can download precompiled Ruby binaries instead of | |
| mise can download precompiled Ruby binaries instead of |
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
a7eb60a to
fa51c5d
Compare
There was a problem hiding this comment.
Code Review
This pull request updates the documentation for Ruby to remove the 'experimental' status for precompiled binaries. The changes correctly remove the experimental badge and the requirement to set experimental = true from the Ruby language guide.
However, I've identified a discrepancy where the underlying code in src/plugins/core/ruby.rs and the setting documentation in docs/settings.toml still indicate that this feature is not enabled by default without the experimental flag. This could lead to user confusion. My review includes a detailed comment on this issue.
Aside from this inconsistency, the documentation changes themselves are clear and well-executed.
| Mise can download precompiled Ruby binaries instead of | ||
| compiling from source. This significantly reduces installation time. |
There was a problem hiding this comment.
While the documentation is being updated to remove the 'experimental' status for precompiled Ruby binaries, the underlying implementation and other documentation seem to still require the experimental = true setting to use precompiled binaries by default.
Specifically:
- The
should_try_precompiledfunction insrc/plugins/core/ruby.rsstill checks forsettings.experimental. Without it, precompiled binaries are only used ifruby.compileis explicitlyfalse.// src/plugins/core/ruby.rs settings.ruby.compile == Some(false) || (settings.experimental && settings.ruby.compile.is_none())
- The documentation for the
ruby.compilesetting indocs/settings.tomlalso states that compiling from source is the default unlessexperimental = true.
This documentation change makes it seem like precompiled binaries are now the default, which could be misleading for users. To make this documentation accurate, the code logic and other related documentation should be updated to not depend on the experimental flag. For example, the logic could be changed to settings.ruby.compile != Some(true) to make precompiled the default.
Hyperfine Performance
|
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
mise-2026.2.8 x -- echo |
23.2 ± 0.4 | 21.8 | 26.6 | 1.00 |
mise x -- echo |
24.0 ± 0.8 | 21.4 | 33.0 | 1.03 ± 0.04 |
mise env
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
mise-2026.2.8 env |
22.3 ± 1.3 | 20.8 | 33.7 | 1.00 ± 0.08 |
mise env |
22.3 ± 1.2 | 20.8 | 34.3 | 1.00 |
mise hook-env
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
mise-2026.2.8 hook-env |
22.3 ± 0.7 | 21.2 | 29.9 | 1.00 |
mise hook-env |
22.4 ± 0.8 | 21.4 | 25.1 | 1.00 ± 0.05 |
mise ls
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
mise-2026.2.8 ls |
20.3 ± 0.4 | 19.6 | 22.3 | 1.00 |
mise ls |
21.8 ± 1.1 | 19.9 | 31.0 | 1.07 ± 0.06 |
xtasks/test/perf
| Command | mise-2026.2.8 | mise | Variance |
|---|---|---|---|
| install (cached) | 123ms | 121ms | +1% |
| ls (cached) | 74ms | 74ms | +0% |
| bin-paths (cached) | 77ms | 79ms | -2% |
| task-ls (cached) | 532ms | 541ms | -1% |
### 🚀 Features - auto-select no-YJIT Ruby on older glibc systems by @jdx in [#8069](#8069) ### 🐛 Bug Fixes - **(shim)** update mise-shim.exe during self-update on Windows by @jdx in [#8075](#8075) - Bump xx to 2.5 by @erickt in [#8077](#8077) ### 📚 Documentation - **(ruby)** remove experimental language for precompiled binaries by @jdx in [#8073](#8073) ### New Contributors - @erickt made their first contribution in [#8077](#8077) ## 📦 Aqua Registry Updates #### Updated Packages (1) - [`carthage-software/mago`](https://github.com/carthage-software/mago)
…x#8073) ## Summary - Remove "experimental" badge from Precompiled Binaries section - Remove requirement for `experimental = true` setting - Precompiled Ruby binaries are stable and no longer need the experimental flag ## Test plan - [ ] Verify docs render correctly 🤖 Generated with [Claude Code](https://claude.com/claude-code) <!-- CURSOR_SUMMARY --> --- > [!NOTE] > **Low Risk** > Documentation-only changes; no runtime or behavior changes, with minimal risk beyond potential user confusion if settings names are incorrect. > > **Overview** > Updates the Ruby docs to treat precompiled binaries as non-experimental by removing the *experimental* badge/language and the need to enable `experimental=true`. > > Replaces the opt-in instructions with `mise settings ruby.compile=false` and notes that precompiled binaries are planned to become the default in `2026.8.0`. > > <sup>Written by [Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit fa51c5d. This will update automatically on new commits. Configure [here](https://cursor.com/dashboard?tab=bugbot).</sup> <!-- /CURSOR_SUMMARY --> Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
### 🚀 Features - auto-select no-YJIT Ruby on older glibc systems by @jdx in [jdx#8069](jdx#8069) ### 🐛 Bug Fixes - **(shim)** update mise-shim.exe during self-update on Windows by @jdx in [jdx#8075](jdx#8075) - Bump xx to 2.5 by @erickt in [jdx#8077](jdx#8077) ### 📚 Documentation - **(ruby)** remove experimental language for precompiled binaries by @jdx in [jdx#8073](jdx#8073) ### New Contributors - @erickt made their first contribution in [jdx#8077](jdx#8077) ## 📦 Aqua Registry Updates #### Updated Packages (1) - [`carthage-software/mago`](https://github.com/carthage-software/mago)
Summary
experimental = truesettingTest plan
🤖 Generated with Claude Code
Note
Low Risk
Documentation-only changes; no runtime or behavior changes, with minimal risk beyond potential user confusion if settings names are incorrect.
Overview
Updates the Ruby docs to treat precompiled binaries as non-experimental by removing the experimental badge/language and the need to enable
experimental=true.Replaces the opt-in instructions with
mise settings ruby.compile=falseand notes that precompiled binaries are planned to become the default in2026.8.0.Written by Cursor Bugbot for commit fa51c5d. This will update automatically on new commits. Configure here.