Use Rubydex to document symbols instead of YARD#2524
Open
Conversation
Morriar
force-pushed
the
at-rubydex-graph
branch
from
0de8ab8 to
d977e25
Compare
Morriar
added
enhancement
Signed-off-by: Alexandre Terrasa <alexandre.terrasa@shopify.com>
Morriar
force-pushed
the
at-rubydex-graph
branch
from
d977e25 to
f783982
Compare
paracycle
reviewed
Mar 5, 2026
vinistock
reviewed
Mar 6, 2026
Morriar
force-pushed
the
at-rubydex-graph
branch
3 times, most recently
from
a15572b to
01951e3
Compare
Use Rubydex to build a graph of declarations from gem files, which will be used for documentation generation. Symbol collection for bootstrapping continues to use the existing Sorbet-based approach.
Morriar
force-pushed
the
at-rubydex-graph
branch
from
01951e3 to
a7c1387
Compare
paracycle
approved these changes
Mar 6, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR replaces YARD/yard-sorbet with Rubydex for generating documentation in RBI files.
rubydexgem dependency and use its graph to bootstrap gem symbols (replacing the previous YARD-based approach)YardDoclistener with a newDocumentationlistener backed by Rubydex's static indexyard-sorbetandyarddependenciesThe impact on performance is pretty nice.
tapioca gems --allon Tapioca itself is now 10x faster and requires 4x less memory.