Skip to content

Commit 1a90685

Browse files
authored
Update README.md
1 parent fef9781 commit 1a90685

1 file changed

Lines changed: 57 additions & 12 deletions

File tree

README.md

Lines changed: 57 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,68 @@
1-
# Reality Patch Notes 🧠➡️🛠️
1+
# Reality Patch Notes — Patch-Notes Summarizer & Composer
22

3-
A changelog for your brain. Track belief updates the way devs track releases: **what changed, why, and what you’re doing about it**.
3+
Cut through release-note fog. Two tiny tools:
44

5-
**Live (tool page):** https://vibeaxis.com/tools/reality-patch-notes/
5+
- **Summarizer:** Pulls **breaking changes**, **new defaults**, **flags to flip**, plus a **quick migration/rollback checklist** you can actually run.
6+
- **Composer:** Paste a messy changelog or fetch a URL → get clean **Markdown buckets** you can ship (and **JSON** for pipelines).
7+
8+
**Live tool:** https://vibeaxis.com/patch-notes-summarizer/
69
**Back to VibeAxis:** https://vibeaxis.com/
710

811
---
912

10-
## What this is
11-
An **append-only log** of belief changes and model updates:
12-
- “I used to think X. Now I think Y.”
13-
- What triggered the change.
14-
- Evidence & receipts (links).
15-
- Confidence and follow-up actions.
13+
## Why use this
14+
Because “we’ll skim it later” turns into outages. This rips signal from noise and hands you the decision points.
15+
16+
**Time:** 60–90s • **Best for:** PMs, devs, ops • **Tip:** paste a version range (`vX→vY`) to catch deprecations you skipped.
17+
18+
---
19+
20+
## What this does
21+
**Summarizer**
22+
- Highlights breaking changes, new defaults, flags/toggles, and a short migration/rollback checklist.
1623

17-
Use it solo or with a team. Keep it public to force clarity.
24+
**Composer**
25+
- Turns long changelogs or blog posts into skimmable buckets:
26+
**Added, Changed, Fixed, Removed, Deprecated, Known issues, Open questions, Highlights.**
27+
- Copy as **Markdown** or export **JSON**.
1828

1929
---
2030

21-
## Format (simple, human)
22-
Each entry is a Markdown file with front matter. Directory by date:
31+
## Quick start
32+
1. **Fetch** a URL or **paste** raw release notes.
33+
2. Click **Summarize** (for decisions) or **Generate** (for buckets).
34+
3. **Copy Markdown** into PRs/notes, or **Export JSON** for your docs pipeline.
35+
36+
---
37+
38+
## Buckets, at a glance
39+
- **Added** — new stuff, launches, newly supported flags
40+
- **Changed** — updates, tweaks, reworks, refactors
41+
- **Fixed** — bugs squashed, regressions addressed
42+
- **Removed / Deprecated** — gone now or going soon
43+
- **Known issues** — admitted limits/bugs
44+
- **Open questions** — TBDs, “needs investigation”
45+
- **Highlights** — imperative takeaways (“Use/Disable/Set/Stop…”) + strong headings that don’t fit other buckets
46+
47+
---
48+
49+
## Pro tips
50+
- Give it **signal**: use the real changelog, not the marketing blog.
51+
- Add **version context** like `v1.8 → v1.10` to surface missed deprecations.
52+
- Short input? It’ll still draft sane bullets—edit in place after you paste to Markdown.
53+
54+
---
55+
56+
## Export & handoff
57+
- **Markdown** → PR descriptions, internal notes, customer updates.
58+
- **JSON** → pipe to docs automation or release dashboards.
59+
60+
---
61+
62+
## Nerd notes
63+
- Headings are strong signals; near-duplicate lines de-duped fuzzily.
64+
- Fetcher has SSRF guards, a small rate-limit, and a 10-minute cache. Very large pages are truncated.
65+
66+
---
2367

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

0 commit comments

Comments
 (0)