Add yard dependencies

[i7an]

Motivation

Add yard dependencies to the Gemfile so you can run yard server.

Changes

• Add yard dependencies

How to test

• Run yard doc and yard server

Summary by CodeRabbit

Release Notes

• Documentation

  • Enhanced README with improved formatting and clearer structure.
  • Added guidance for generating and running documentation locally.

• Chores

  • Added new project dependencies.
  • Updated CI/CD workflow configuration.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

📝 Walkthrough

Walkthrough

The pull request updates GitHub Actions workflow triggers with branch filtering for main, adds three new Ruby dependencies (rack, rackup, webrick) to the Gemfile, and enhances README documentation with instructions for generating and serving local documentation.

Changes

Cohort / File(s)	Summary
GitHub Actions Workflow .github/workflows/main.yml	Replaced shorthand trigger syntax with explicit block format, adding branch filter for push events to main while keeping pull_request unfiltered.
Dependencies Gemfile	Added three new gems: rack, rackup, and webrick to expand project dependencies.
Documentation README.md	Reformatted paragraphs with adjusted line breaks and added guidance for generating and serving local documentation using yard commands.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Suggested reviewers

• mklocek
• IgorDobryn
• DagonWat

Poem

🐰 Through workflows we bound with expanded delight,
New gems in our toolbox shine ever so bright,
With yard commands documented and clear,
The path to the finish now draws itself near! 🌟

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title 'Add yard dependencies' directly aligns with the primary change in the changeset - adding yard-related gems to the Gemfile.
Description check	✅ Passed	The PR description includes Motivation and Changes sections as required, with a How to test section containing test checkboxes, though it lacks the optional Images and GIFs section.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

🤖 Fix all issues with AI agents

In `@README.md`:
- Line 236: The sentence starting "Versions of this package up to 2.0.2 were an
unofficial client..." uses the adverb "completely" awkwardly; edit that sentence
to replace "completely" with "entirely" or remove the adverb (e.g., "Package
version 3 is an entirely new package." or "Package version 3 is a new package.")
to improve wording and clarity.

[coderabbitai]

⚠️ Potential issue | 🟡 Minor

Minor wording polish.
Line 236: consider replacing “completely” with “entirely” or dropping the adverb.

✍️ Suggested edit

-Versions of this package up to 2.0.2 were an [unofficial client](https://github.com/vchin/mailtrap-client) developed by [`@vchin`](https://github.com/vchin). Package version 3 is a completely new package. 
+Versions of this package up to 2.0.2 were an [unofficial client](https://github.com/vchin/mailtrap-client) developed by [`@vchin`](https://github.com/vchin). Package version 3 is an entirely new package.

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

	Versions of this package up to 2.0.2 were an [unofficial client](https://github.com/vchin/mailtrap-client) developed by [@vchin](https://github.com/vchin). Package version 3 is a completely new package.
	Versions of this package up to 2.0.2 were an [unofficial client](https://github.com/vchin/mailtrap-client) developed by [`@vchin`](https://github.com/vchin). Package version 3 is an entirely new package.

🧰 Tools

🪛 LanguageTool

[style] ~236-~236: Consider using a different adverb to strengthen your wording.
Context: ...github.com/vchin). Package version 3 is a completely new package.

(COMPLETELY_ENTIRELY)

🤖 Prompt for AI Agents

In `@README.md` at line 236, The sentence starting "Versions of this package up to
2.0.2 were an unofficial client..." uses the adverb "completely" awkwardly; edit
that sentence to replace "completely" with "entirely" or remove the adverb
(e.g., "Package version 3 is an entirely new package." or "Package version 3 is
a new package.") to improve wording and clarity.