Skip to content

Add tags to changelog #992

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 6, 2025
Merged

Add tags to changelog #992

merged 1 commit into from
Aug 6, 2025

Conversation

ethanpalm
Copy link
Contributor

Documentation changes

This PR adds tags to the changelog. As part of this, we'd establish three tags for the changelog:

  • New releases
  • Improvements
  • Sunsets (note: we haven't added deprecations to the changelog so far, but would moving forward)

For Reviewers

When reviewing documentation PRs, please consider:

✅ Technical accuracy

  • Code examples work as written
  • Commands and configurations are correct
  • Links resolve to the right destinations
  • Prerequisites and requirements are accurate

✅ Clarity and completeness

  • Instructions are clear and easy to follow
  • Steps are in logical order
  • Nothing important is missing
  • Examples help illustrate the concepts

✅ User experience

  • A new user could follow these docs successfully
  • Common gotchas or edge cases are addressed
  • Error messages or troubleshooting guidance is helpful

Copy link
Contributor

@ruhanponnada ruhanponnada left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@ethanpalm ethanpalm merged commit f96d8f4 into main Aug 6, 2025
4 checks passed
@ethanpalm ethanpalm deleted the changelog-tags branch August 6, 2025 17:47
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.

2 participants