[GH-7352] Use GitHub Pages for Rubyzen documentation#28
Merged
Stelios Frantzeskakis (steliosfran) merged 2 commits intoMay 18, 2026
Merged
Conversation
Copilot started reviewing on behalf of
Stelios Frantzeskakis (steliosfran)
May 18, 2026 21:13
View session
There was a problem hiding this comment.
Pull request overview
Sets up YARD-based documentation for the Rubyzen gem and publishes it via GitHub Pages. Adds module-level docstrings throughout lib/rubyzen, wraps the dynamically-defined RSpec matchers in YARD @!parse blocks so they appear in the generated docs, adds a .yardopts config, and a workflow that builds and deploys docs to GitHub Pages on pushes to main. Also registers the new documentation_uri in the gemspec.
Changes:
- Add YARD module/method docstrings across
lib/rubyzen/**and convert matcher comments into@!parsestubs so they're documented as methods onRubyzen::Matchers. - Introduce
.yardoptsand aDocsGitHub Actions workflow that builds YARD output and deploys it to GitHub Pages. - Wire up
documentation_uriinrubyzen-lint.gemspecand addwebrickto the development Gemfile group (needed foryard server).
Reviewed changes
Copilot reviewed 14 out of 14 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| rubyzen-lint.gemspec | Adds documentation_uri metadata pointing at GitHub Pages site. |
| lib/rubyzen/version.rb | Adds YARD docstring on VERSION. |
| lib/rubyzen/providers/blocks_provider.rb | Adds module-level docstring on Providers. |
| lib/rubyzen/parsers/a_s_t_parser.rb | Adds module-level docstring on Parsers. |
| lib/rubyzen/matchers/zen_true_matcher.rb | Replaces top-level comment with @!parse block exposing zen_true as a documented method. |
| lib/rubyzen/matchers/zen_false_matcher.rb | Same treatment for zen_false (drops the "custom failure message" example). |
| lib/rubyzen/matchers/zen_empty_matcher.rb | Same treatment for zen_empty (swaps "custom message" example for a baseline example). |
| lib/rubyzen/matchers/matcher_helpers.rb | Adds module docstring on Matchers and @!method directive describing message_for_failure. |
| lib/rubyzen/declarations/file_declaration.rb | Adds module-level docstring on Declarations. |
| lib/rubyzen/collections/base_collection.rb | Adds module-level docstring on Collections. |
| lib/rubyzen/cache/parse_cache.rb | Adds module-level docstring on Cache. |
| Gemfile | Adds webrick dev dependency for yard server. |
| .yardopts | New YARD config: output dir, markdown markup, included files. |
| .github/workflows/docs.yml | New workflow building YARD and deploying to GitHub Pages on main. |
Adam Tucker (adamjt)
approved these changes
May 18, 2026
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.
What changed and why
Checklist
bundle exec rspec spec/passes locally[GH-7352] Use GitHub Pages for Rubyzen documentation