Migrate documentation to rdoc - #5689
Open
ydah wants to merge 7 commits into
Open
Conversation
ydah
force-pushed
the
migrate-documentation-to-rdoc
branch
from
August 9, 2026 00:37
f7a0a04 to
47c61be
Compare
Owner
|
Hey, thanks so much for taking a crack at this! I just pulled the branch and built the docs locally. In general I think this is great, but I'd like to get a few more things before replacing the YARD docs with this:
I'm going to continue reviewing but I thought I'd share those ideas now to see what you think. |
ydah
force-pushed
the
migrate-documentation-to-rdoc
branch
from
August 10, 2026 15:25
47c61be to
c9cfb98
Compare
ydah
force-pushed
the
migrate-documentation-to-rdoc
branch
from
August 10, 2026 15:53
2bbd72b to
0087637
Compare
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
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.

Fixes: #5576
This PR completes the migration of the GraphQL Ruby documentation site from YARD/Jekyll to RDoc/Aliki.
It adds the RDoc build and CI checks, converts guide metadata and YARD comments, moves API-specific guide content into source comments, preserves legacy documentation URLs, and removes the legacy YARD pipeline. The generated API documentation is checked against the pre-migration public API inventory to detect unexpected coverage changes.
The generated site also includes GraphQL syntax highlighting, local-file-friendly image links, correct README rendering, nested guide navigation with page titles, and complete development guide table-of-contents links. No GraphQL runtime behavior is changed.
Validated with
bundle exec rake docs:check, the documentation generator specs, the link checker, the RDoc reference checker, and the GraphQL highlighter tests.