java
java copied to clipboard
Improved README: resource descriptions, platform table
Description
This PR updates the README to improve clarity and usability for new users.
Changes include:
- Added a clear and structured Supported Platforms table.
- Expanded the Resources Overview section with brief descriptions of each resource.
- Improved readability and organization of documentation sections.
These changes are documentation-only and do not modify cookbook functionality.
Issues Resolved
- N/A — documentation improvement.
(If linking to an issue, replace with:Closes #<issue-number>.)
Check List
- [ ] All commit messages follow Conventional Commits format
- Example used:
docs: update resource descriptions and add platform table in README
- Example used:
- [ ] New functionality includes testing (N/A)
- [ ] New functionality has been documented in the README if applicable
⚠️ Important: Automated Release Workflow
DO NOT manually edit these files:
- ❌
metadata.rbversion - ❌
CHANGELOG.md - ❌ Git tags
All are handled automatically by release-please.
Release process:
- Merge PR → release-please opens a release PR
- Merge release PR → version bump + changelog update + publish
- Documentation changes will be included in the next release 🎉
Need help with Conventional Commits?
See: https://www.conventionalcommits.org/