Skip to content

Add guide to changelogs + subscribable RSS feeds #824

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 27 commits into from
Jun 24, 2025

Conversation

lawreka
Copy link
Contributor

@lawreka lawreka commented Jun 17, 2025

Documentation changes

Brief description of what's being updated

Closes https://linear.app/mintlify/issue/DOC-64/guide-on-setting-up-a-changelog


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

@ethanpalm ethanpalm marked this pull request as ready for review June 23, 2025 16:28
@ethanpalm ethanpalm merged commit 163ddfa into main Jun 24, 2025
4 checks passed
@ethanpalm ethanpalm deleted the kathryn/changelogs-guide branch June 24, 2025 20:38
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.

3 participants