Update Rakefile to use YARD::Rake::YardocTask instead of Rake::RDocTask #94

New issue

Open

opened 2026-03-15 04:13:10 +00:00 by freemo · 0 comments

freemo commented

2026-03-15 04:13:10 +00:00

Owner

Metadata

Commit Message: chore(build): update Rakefile to use YARD task
Branch: feature/m1-yard-migration

Background and Context

The Rakefile currently uses Rake::RDocTask for documentation generation. This must
be replaced with YARD::Rake::YardocTask.

Expected Behavior

rake yard generates YARD documentation
Output goes to doc/ directory
All source files under lib/ are included

Acceptance Criteria

Rake::RDocTask references removed from Rakefile
YARD::Rake::YardocTask configured in Rakefile
rake yard runs successfully and generates HTML docs

Subtasks

Remove RDocTask from Rakefile
Add YardocTask configuration
Verify rake yard generates output

Definition of Done

This issue is complete when:

All subtasks above are completed and checked off.
A Git commit is created where the first line of the commit message matches the
Commit Message in Metadata exactly.
The commit is pushed to the remote on the branch matching the Branch in Metadata.
The commit is submitted as a pull request to master, reviewed, and merged.

## Metadata - **Commit Message**: `chore(build): update Rakefile to use YARD task` - **Branch**: `feature/m1-yard-migration` ## Background and Context The Rakefile currently uses `Rake::RDocTask` for documentation generation. This must be replaced with `YARD::Rake::YardocTask`. ## Expected Behavior - `rake yard` generates YARD documentation - Output goes to `doc/` directory - All source files under `lib/` are included ## Acceptance Criteria - `Rake::RDocTask` references removed from Rakefile - `YARD::Rake::YardocTask` configured in Rakefile - `rake yard` runs successfully and generates HTML docs ## Subtasks - [ ] Remove RDocTask from Rakefile - [ ] Add YardocTask configuration - [ ] Verify `rake yard` generates output ## Definition of Done This issue is complete when: - All subtasks above are completed and checked off. - A Git commit is created where the **first line** of the commit message matches the Commit Message in Metadata exactly. - The commit is pushed to the remote on the branch matching the **Branch** in Metadata. - The commit is submitted as a **pull request** to `master`, reviewed, and **merged**.