Skip to content

Vibeaxis/reality-patchnotes

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 

Repository files navigation

Reality Patch Notes — Patch-Notes Summarizer & Composer

Cut through release-note fog. Two tiny tools:

  • Summarizer: Pulls breaking changes, new defaults, flags to flip, plus a quick migration/rollback checklist you can actually run.
  • Composer: Paste a messy changelog or fetch a URL → get clean Markdown buckets you can ship (and JSON for pipelines).

Live tool: https://vibeaxis.com/patch-notes-summarizer/ Back to VibeAxis: https://vibeaxis.com/


Why use this

Because “we’ll skim it later” turns into outages. This rips signal from noise and hands you the decision points.

Time: 60–90s • Best for: PMs, devs, ops • Tip: paste a version range (vX→vY) to catch deprecations you skipped.


What this does

Summarizer

  • Highlights breaking changes, new defaults, flags/toggles, and a short migration/rollback checklist.

Composer

  • Turns long changelogs or blog posts into skimmable buckets:
    Added, Changed, Fixed, Removed, Deprecated, Known issues, Open questions, Highlights.
  • Copy as Markdown or export JSON.

Quick start

  1. Fetch a URL or paste raw release notes.
  2. Click Summarize (for decisions) or Generate (for buckets).
  3. Copy Markdown into PRs/notes, or Export JSON for your docs pipeline.

Buckets, at a glance

  • Added — new stuff, launches, newly supported flags
  • Changed — updates, tweaks, reworks, refactors
  • Fixed — bugs squashed, regressions addressed
  • Removed / Deprecated — gone now or going soon
  • Known issues — admitted limits/bugs
  • Open questions — TBDs, “needs investigation”
  • Highlights — imperative takeaways (“Use/Disable/Set/Stop…”) + strong headings that don’t fit other buckets

Pro tips

  • Give it signal: use the real changelog, not the marketing blog.
  • Add version context like v1.8 → v1.10 to surface missed deprecations.
  • Short input? It’ll still draft sane bullets—edit in place after you paste to Markdown.

Export & handoff

  • Markdown → PR descriptions, internal notes, customer updates.
  • JSON → pipe to docs automation or release dashboards.

Nerd notes

  • Headings are strong signals; near-duplicate lines de-duped fuzzily.
  • Fetcher has SSRF guards, a small rate-limit, and a 10-minute cache. Very large pages are truncated.

Live tool: https://vibeaxis.com/tools/reality-patch-notes/Back to VibeAxis: https://vibeaxis.com/

About

A changelog for your brain. Track belief updates the way devs track releases: **what changed, why, and what you’re doing about it

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published