You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
chore: consolidate root docs and retire per-version release-notes pattern
- Delete 178 RELEASE_NOTES_v*.md files; the full history already lives in
CHANGELOG.md as `## vX.Y.Z` sections with stable `#vX.Y.Z` anchors.
- Rewrite .github/workflows/release.yml to extract each release body from
the matching CHANGELOG section between `<a id="vX.Y.Z">` anchors instead
of reading per-file notes.
- Rewrite every active doc/code/asset reference to the new
CHANGELOG.md#vX.Y.Z anchor form; .ai/research/<date>/ snapshots left as
frozen historical artefacts.
- Move 7 planning/research snapshots to docs/archive/: SWIFTKEY_AI_RESEARCH,
SWIFTKEY_FEATURE_IMPLEMENTATION_PLAN, SWIFTKEY_PARITY_AUDIT,
SWIFTKEY_PARITY_BUILD_PLAN, SWIFTKEY_PARITY_RESEARCH,
SWIFTKEY_PARITY_ROADMAP_2026-05-17, ROADMAP_RESEARCH_ADDENDUM_2026-05-17.
- Remove stale README.md.bak.
- Bump gradle.properties to 1.8.171 / versionCode 1971; sync README badge.
- Update CHANGELOG v1.8.171 entry to describe the full consolidation.
— most recent research-run additions and corrections, not yet folded
31
31
into `ROADMAP.md`.
32
32
8.[`.ai/research/<YYYY-MM-DD>/`](.ai/research/) — full research-run
@@ -131,7 +131,7 @@ commands above.
131
131
| If your change is… | Lives in… |
132
132
|---|---|
133
133
| One feature slice, one release | A new `RELEASE_NOTES_vX.Y.Z.md` at repo root + a `gradle.properties` bump |
134
-
| A SwiftKey-parity slice (Phase A/B/C/D/E) | The "Phased plan" in [SWIFTKEY_PARITY_ROADMAP_2026-05-17.md](SWIFTKEY_PARITY_ROADMAP_2026-05-17.md)|
134
+
| A SwiftKey-parity slice (Phase A/B/C/D/E) | The "Phased plan" in [docs/archive/SWIFTKEY_PARITY_ROADMAP_2026-05-17.md](docs/archive/SWIFTKEY_PARITY_ROADMAP_2026-05-17.md)|
135
135
| A roadmap-tier change (NOW / NEXT / LATER / UNDER CONSIDERATION) |[ROADMAP.md](ROADMAP.md) §6/§7/§8/§9 |
136
136
| A quality / a11y / perf / test / CI / release-hygiene workstream |[IMPROVEMENT_PLAN.md](IMPROVEMENT_PLAN.md)|
137
137
| A research finding | New `.ai/research/<YYYY-MM-DD>/` directory; updates fold into the next `ROADMAP.md``v5.X` refresh |
[IMPROVEMENT_PLAN.md](IMPROVEMENT_PLAN.md), or any per-release notes — it
12
12
distills their durable content into one page so those longer documents
13
13
don't have to be re-read every time.
@@ -561,11 +561,11 @@ subsystem map in
561
561
562
562
| If your change is… | Lives in… |
563
563
|---|---|
564
-
| One feature slice, one release | A new `RELEASE_NOTES_vX.Y.Z.md` at repo root + a `gradle.properties` bump |
565
-
| A SwiftKey-parity slice (Phase A/B/C/D/E) | The "Phased plan" in [SWIFTKEY_PARITY_ROADMAP_2026-05-17.md](SWIFTKEY_PARITY_ROADMAP_2026-05-17.md)|
564
+
| One feature slice, one release | A new `## vX.Y.Z` section appended to [CHANGELOG.md](CHANGELOG.md) + a `gradle.properties` bump |
565
+
| A SwiftKey-parity slice (Phase A/B/C/D/E) | The "Phased plan" in [docs/archive/SWIFTKEY_PARITY_ROADMAP_2026-05-17.md](docs/archive/SWIFTKEY_PARITY_ROADMAP_2026-05-17.md) (snapshot; migrate active items into `ROADMAP.md`) |
566
566
| A roadmap-tier change (NOW / NEXT / LATER / UNDER CONSIDERATION) |[ROADMAP.md](ROADMAP.md) §6/§7/§8/§9 |
567
567
| A quality / a11y / perf / test / CI / release-hygiene workstream |[IMPROVEMENT_PLAN.md](IMPROVEMENT_PLAN.md)|
568
-
| A research finding that updates a prior roadmap claim |[ROADMAP_RESEARCH_ADDENDUM_2026-05-17.md](ROADMAP_RESEARCH_ADDENDUM_2026-05-17.md) (this run's addendum) |
568
+
| A research finding that updates a prior roadmap claim |[docs/archive/ROADMAP_RESEARCH_ADDENDUM_2026-05-17.md](docs/archive/ROADMAP_RESEARCH_ADDENDUM_2026-05-17.md) (snapshot; fold corrections into `ROADMAP.md`) |
-[CHANGESET_SUMMARY.md](.ai/research/2026-05-17/CHANGESET_SUMMARY.md) — what this research run created or changed
748
-
- (At repo root) [ROADMAP_RESEARCH_ADDENDUM_2026-05-17.md](ROADMAP_RESEARCH_ADDENDUM_2026-05-17.md) — the actionable additions
750
+
- (At repo root) [docs/archive/ROADMAP_RESEARCH_ADDENDUM_2026-05-17.md](docs/archive/ROADMAP_RESEARCH_ADDENDUM_2026-05-17.md) — the actionable additions
749
751
750
752
Future research runs should follow the same `.ai/research/<YYYY-MM-DD>/`
751
753
convention so prior runs remain auditable.
@@ -756,9 +758,9 @@ convention so prior runs remain auditable.
756
758
|---|---|
757
759
| Project pitch + setup |[README.md](README.md)|
758
760
| The big roadmap with full history |[ROADMAP.md](ROADMAP.md)|
759
-
| The current sprint plan |[SWIFTKEY_PARITY_ROADMAP_2026-05-17.md](SWIFTKEY_PARITY_ROADMAP_2026-05-17.md)|
760
-
| The latest research run's recommendations |[ROADMAP_RESEARCH_ADDENDUM_2026-05-17.md](ROADMAP_RESEARCH_ADDENDUM_2026-05-17.md)|
761
+
| The current sprint plan |[docs/archive/SWIFTKEY_PARITY_ROADMAP_2026-05-17.md](docs/archive/SWIFTKEY_PARITY_ROADMAP_2026-05-17.md)|
762
+
| The latest research run's recommendations |[docs/archive/ROADMAP_RESEARCH_ADDENDUM_2026-05-17.md](docs/archive/ROADMAP_RESEARCH_ADDENDUM_2026-05-17.md) (snapshot) |
761
763
| Quality / a11y / perf / test plan |[IMPROVEMENT_PLAN.md](IMPROVEMENT_PLAN.md)|
762
764
| Threat model + security posture |[docs/THREAT_MODEL.md](docs/THREAT_MODEL.md) + [docs/SECURITY.md](docs/SECURITY.md)|
763
-
| What ships in the next release |The latest `RELEASE_NOTES_v*.md`|
765
+
| What ships in the next release |Top section of [CHANGELOG.md](CHANGELOG.md)|
764
766
| What I'm allowed to put in `:app`| §2 above + [ROADMAP.md](ROADMAP.md) §1, §10 |
0 commit comments