Skip to content

Remove YARD-to-RDoc migration tooling - #5786

Merged
rmosolgo merged 2 commits into
masterfrom
claude/yard-rdoc-migration-cleanup-34652d
Oct 16, 2026
Merged

rmosolgo merged 2 commits into
masterfrom
claude/yard-rdoc-migration-cleanup-34652d

Conversation

@rmosolgo

Copy link
Copy Markdown
Owner

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.rb and its spec: converted Jekyll/Liquid guides to RDoc markdown. Every guide is converted, and tool/docs/check.rb already rejects new Liquid tags.
  • tool/docs/guide_audit.rb, docs/guide_classification.yml and the spec: verified that API guides moved into source comments.
  • docs/yard_api_baseline.yml and the --baseline comparison in tool/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 in lib/graphql/{query,schema,schema/argument,schema/field}.rb, which only guide_audit.rb read.
  • References to the old guides/yardoc/ / Jekyll directories in .gitignore, tool/docs/build.rb and generator_spec.rb.
  • The migrate_guides / guide_audit / --baseline steps in rake docs:check.

Kept on purpose

  • tool/docs/type_signatures.rb: its --check still 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:

  • docs specs
  • rake docs:check
  • rake docs:build_twice
  • tool/docs/gem_install_check.rb
  • the versioned-API steps for master (build_version, version_check, compatibility --strict, rdoc_ref_checker)
  • rubocop on the changed files

🤖 Generated with Claude Code

rmosolgo and others added 2 commits October 16, 2026 09:24
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
@rmosolgo

Copy link
Copy Markdown
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 tool/docs/compatibility.rb because we generate some custom pages that might produce unusual output with RDoc's search index.

@rmosolgo
rmosolgo merged commit 2283351 into master Oct 16, 2026
16 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant