yard doc implementation

[eddyjaga]

Short Description / Link to Ticket

This pull request adds support for generating API documentation with YARD, updates documentation configuration, and includes a minor fix to the README.md to resolve a YARD warning. It also bumps the gem version to 1.3.2. The most important changes are grouped below:

Documentation and Tooling Improvements:

• Added .yardopts configuration file to enable YARD documentation generation and set markdown as the markup format.
• Added the yard gem as a development dependency in the Gemfile.
• Updated the CHANGELOG.md to document the new YARD support, the addition of the yard gem, and current documentation coverage.
• Configured YARD to generate comprehensive API documentation and fixed a YARD link resolution warning in README.md by converting a markdown link to HTML format. [1] [2]

Version Update:

• Bumped the gem version from 1.3.1 to 1.3.2 in lib/zai_payment/version.rb.

Testing

Additional Notes