Skip to content

Conversation

@rohit2143
Copy link

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
  • 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.rb version
  • CHANGELOG.md
  • ❌ Git tags

All are handled automatically by release-please.

Release process:

  1. Merge PR → release-please opens a release PR
  2. Merge release PR → version bump + changelog update + publish
  3. Documentation changes will be included in the next release 🎉

Need help with Conventional Commits?
See: https://www.conventionalcommits.org/

@rohit2143 rohit2143 requested a review from a team as a code owner December 11, 2025 14:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant