Skip to content

Publish YARD API docs to GitHub Pages #25

Description

@Amayyas

What

The codebase already has YARD-style comments on every public class/method (per the original MVP quality bar) but nothing renders or verifies them. Add a workflow that builds YARD docs and publishes them to GitHub Pages on release.

Acceptance criteria

  • .yardopts added if needed
  • YARD docs build cleanly with no warnings
  • Workflow publishes to GitHub Pages on new releases
  • Link added to README

Metadata

Metadata

Assignees

No one assigned

    Labels

    ci-cdCI/CD pipeline improvementsdocumentationImprovements or additions to documentation

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions