Add a README-refresh item to the backlog - #430
Merged
Merged
Conversation
The README has gone stale. Capture the work to refresh it and evaluate a lower-maintenance structure - a per-section index pointing into the docs with short descriptions, keeping the README as the adoption and audit-instruction entry point - noting the sync obligation that structure carries. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new backlog item to the README's TODO section to track refreshing the README content and potentially restructuring it into a lower-maintenance, doc-index style while acknowledging the ongoing sync burden.
Changes:
- Add a README TODO backlog entry describing a planned README refresh and evaluation of an index-based structure.
Uh oh!
There was an error while loading. Please reload this page.
ptr727 added a commit
that referenced
this pull request
Jul 25, 2026
…) (#434) ## Promote develop to main Four doc/spec-only changes, all squashed to develop and Copilot-clean: - **#430** - README backlog: refresh the stale README + evaluate a lower-maintenance structure. - **#431** - README backlog: a linter-only Python type (codegen/boilerplate: no tests/coverage, linter only) distinct from the utility `python` type; ESPHome-Config `+python` deferred until it exists. - **#432** - `audit.py` branch check now splits "develop genuinely behind" (forward-sync) from "changed on both / develop may supersede", with a `classify_branch_drift()` helper + selftest. Surfaced by the PlexCleaner convergence, where develop was ahead but read as a forward-sync gap. - **#433** - canonical `build-release-task.yml` artifact-delete uses the `if ! …; then` form instead of a force-success tail (matches the listing step; write-safety compliant). Changes the `github-release` verbatim region → fleet re-vendors next cycle. No code/workflow changes to the hub's own pipeline - documentation and spec only, so no release fires on merge. ## Verification - `spec/validate.py` OK; `spec/audit.py --selftest` PASS. 🤖 Generated with [Claude Code](https://claude.com/claude-code)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds one backlog item to the README TODO section: refresh the stale README and evaluate a lower-maintenance structure (a per-section index pointing into the docs with short descriptions, keeping the README as the adoption + audit-instruction entry point), noting the sync obligation such a structure carries.
Docs-only.
spec/validate.pyOK.🤖 Generated with Claude Code