synapse/goatcounter-stats-gateway
1
0
Fork 0
Code Issues Pull requests Projects Releases 6 Packages Wiki Activity Actions

docs: version-rot fixes + npm README panels #17

Merged
synapse merged 1 commit from docs/version-rot into develop 2026-08-21 23:46:19 +00:00
Conversation 0 Commits 1 Files changed 3 +28 -10
synapse commented 2026-08-21 23:43:59 +00:00
Owner
Copy link

Docs-freshness audit after v0.3.0 found three rots:

  1. README + Installation pinned v0.2.0 in copy-paste examples — replaced with a vX.Y.Z placeholder + releases-page pointer, so this rot class is dead rather than deferred.
  2. README Status opened with a hardcoded version — now version-agnostic and names the panel surface.
  3. The npm package README shipped in 0.3.0 without documenting panels (0.3.0's own feature) — panels section added (discovery, fetchPanel, panels attribute, self-configuration, updated parts). Reaches npmjs with the next published version; the repo/book copy is correct immediately.

Docs-only; book builds clean.

🤖 Generated with Claude Code

https://claude.ai/code/session_01T5j3dAJVcUjZv9k76sRTt9

Docs-freshness audit after v0.3.0 found three rots: 1. README + Installation pinned `v0.2.0` in copy-paste examples — replaced with a `vX.Y.Z` placeholder + releases-page pointer, so this rot class is dead rather than deferred. 2. README Status opened with a hardcoded version — now version-agnostic and names the panel surface. 3. The npm package README shipped in 0.3.0 without documenting panels (0.3.0's own feature) — panels section added (discovery, fetchPanel, `panels` attribute, self-configuration, updated parts). Reaches npmjs with the next published version; the repo/book copy is correct immediately. Docs-only; book builds clean. 🤖 Generated with [Claude Code](https://claude.com/claude-code) https://claude.ai/code/session_01T5j3dAJVcUjZv9k76sRTt9
docs: kill version rot; npm README learns about panels
All checks were successful
ci / gate (pull_request) Successful in 35s
Details
75c6665c29
 
Install examples use a vX.Y.Z placeholder with a pointer to the releases
page (concrete pins rotted every release); README status is version-
agnostic and now names the panel surface. The npm package README —
published in 0.3.0 without mentioning 0.3.0's own headline feature —
gains the panels section (discovery, fetchPanel, panels attribute,
self-configuration, new parts); it reaches npmjs with the next release.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01T5j3dAJVcUjZv9k76sRTt9
synapse merged commit 1347624d1a into develop 2026-08-21 23:46:19 +00:00
synapse deleted branch docs/version-rot 2026-08-21 23:46:19 +00:00
Sign in to join this conversation.
Reviewers
No reviewers
Labels
Clear labels
No items
No labels
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
synapse/goatcounter-stats-gateway!17
No description provided.