Repository navigation
Remove YARD-to-RDoc migration tooling - #5786
Merged
Merged
Conversation
The migration is finished, so the converters and audits that only existed to drive or verify it are dead weight: - Remove tool/docs/migrate_guides.rb (Liquid -> RDoc guide converter) - Remove tool/docs/guide_audit.rb and docs/guide_classification.yml - Remove docs/yard_api_baseline.yml and the baseline comparison in tool/docs/compatibility.rb (the index sanity check stays) - Drop "migrated from" markers in lib/ that only guide_audit read - Drop references to the old guides/yardoc and Jekyll directories Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…/yard-rdoc-migration-cleanup-34652d # Conflicts: # docs/yard_api_baseline.yml
Owner
Author
|
cc @ydah -- I believe we're all done with this code now that YARD is gone. Please let me know if I removed something that we still benefit from! I kept |
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.
Follow-up to #5689. Now that the docs migration is done, this removes code that only existed to drive or verify it (~1,700 lines).
Removed
tool/docs/migrate_guides.rband its spec: converted Jekyll/Liquid guides to RDoc markdown. Every guide is converted, andtool/docs/check.rbalready rejects new Liquid tags.tool/docs/guide_audit.rb,docs/guide_classification.ymland the spec: verified that API guides moved into source comments.docs/yard_api_baseline.ymland the--baselinecomparison intool/docs/compatibility.rb. The checks that the RDoc search index has no duplicates and every entry links to a real page and anchor are unchanged.# migrated from …markers inlib/graphql/{query,schema,schema/argument,schema/field}.rb, which onlyguide_audit.rbread.guides/yardoc// Jekyll directories in.gitignore,tool/docs/build.rbandgenerator_spec.rb.migrate_guides/guide_audit/--baselinesteps inrake docs:check.Kept on purpose
tool/docs/type_signatures.rb: its--checkstill enforces:call-seq:on new methods.tool/docs/legacy.rb(LegacyAnchors): keeps old YARD-style method anchors working for inbound links.tool/docs/redirects.rb/docs/redirects.yml: keep old guide URLs working.Verification
Run locally:
rake docs:checkrake docs:build_twicetool/docs/gem_install_check.rbmaster(build_version,version_check,compatibility --strict,rdoc_ref_checker)🤖 Generated with Claude Code