Skip to content

Commit 84fa294

Browse files
0xAHAclaude
andcommitted
docs: link release notes to GitHub instead of duplicating them
The site page had stopped at v0.9.10 while the integration shipped v1.5.0 -- around twenty releases behind, stale since early July. It was a hand copy of RELEASENOTES.md, so it only stayed current if someone remembered to update two files, and nobody did. Copying the file in at build time was the obvious alternative and does not work: RELEASENOTES.md contains links relative to the repository root, which resolve to nothing once rendered at /release-notes/. So the page now points at the GitHub releases, which are written as part of cutting each release and are therefore always current. It keeps its place in the nav, notes that HACS shows pending release notes before you install, and explains where breaking changes appear and how to roll back. CLAUDE.md gains the general form: prefer linking to a canonical source over copying it. A page restating something maintained elsewhere is a second copy kept in step by hand, and it never is. Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 28d5395 commit 84fa294

2 files changed

Lines changed: 19 additions & 279 deletions

File tree

CLAUDE.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -162,6 +162,12 @@ Before calling a change complete, ask which page would now be wrong:
162162
| New supported model | `hardware/models.md`, `hardware/autodetection.md` |
163163
| Gateway or adapter finding | `troubleshooting/rs485-gateways.md` |
164164

165+
**Prefer linking to a canonical source over copying it.** A page that restates something
166+
maintained elsewhere — release notes, a register table, a version number — is a second copy
167+
that has to be kept in step by hand, and it never is. Link to the source, or generate the
168+
page from it. Only duplicate when the copy is genuinely for a different audience, and then
169+
add a test that holds the two together.
170+
165171
Two things that make this fail quietly:
166172

167173
- **A new page must be added to `mkdocs.yml` nav.** The build succeeds without it, so

0 commit comments

Comments
 (0)