Skip to content

Improve README for clarity and consistency in setup instructions - #17

Merged
ptr727 merged 2 commits into
developfrom
docs1
Jan 16, 2026
Merged

Improve README for clarity and consistency in setup instructions#17
ptr727 merged 2 commits into
developfrom
docs1

Conversation

@ptr727

@ptr727 ptr727 commented Jan 16, 2026

Copy link
Copy Markdown
Owner

Signed-off-by: Pieter Viljoen ptr727@users.noreply.github.com

Signed-off-by: Pieter Viljoen <ptr727@users.noreply.github.com>
Copilot AI review requested due to automatic review settings January 16, 2026 00:53
@ptr727
ptr727 enabled auto-merge (squash) January 16, 2026 00:53

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR improves the README.md documentation by enhancing clarity and consistency across setup instructions and branching workflow sections.

Changes:

  • Separated Visual Studio Code and Visual Studio installation instructions into distinct bullet points for better clarity
  • Updated links and descriptions for GitHub Local Actions setup to be more specific and clear
  • Enhanced branching workflow instructions with better clarity on branch protection and merge strategies

Comment thread README.md Outdated
Signed-off-by: Pieter Viljoen <ptr727@users.noreply.github.com>
@ptr727
ptr727 merged commit 8f12848 into develop Jan 16, 2026
18 checks passed
@ptr727
ptr727 deleted the docs1 branch January 16, 2026 01:15
ptr727 added a commit that referenced this pull request Jul 17, 2026
Spell out the bare #17 as HomeAssistant-Config #17 so the promotion PR
reference is unambiguous in the fleet registry. Flagged by Copilot on #342.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
ptr727 added a commit that referenced this pull request Jul 17, 2026
Reconcile the stale `HomeAssistant-Config` registry `driftNotes` after
the [`#16`](ptr727/HomeAssistant-Config#16)
operational onboarding. Mirrors the `#329` reconciliation for
Vantage-Config.

## What changed

The prior driftNotes described work that is now complete and planned a
`groundTruthBranch` flip that is declined:

- "develop is behind main by 2 commits / fast-forward then flip
groundTruthBranch to develop" - develop is content-ahead; the flip is
**declined** (see below).
- "pending: lint CI" - `test-pull-request.yml` with the `Check pull
request workflow status job` required check is live.
- "pending: dispatch-only source-release scaffolding (version.json +
publish-release.yml)" - both present.

Replaced with a completed-onboarding summary: baseline carried
(repo-config operational, `AUDIT.md`, `spec/secrets.json`, App-signed
Dependabot merge-bot) and promoted `develop -> main` via
HomeAssistant-Config PR `#17`. Self-audit verified in sync (settings,
both rulesets, `CODEGEN_APP_*` present in both stores).

## groundTruthBranch stays `main` (deliberate)

Kept `groundTruthBranch: main`, **not** flipped to `develop`. develop is
the working branch (direct signed commits); main is the promoted stable
snapshot the audit should target. This is a deliberate divergence from
the other operational repos (Vantage-Config / ESPHome-Config /
HomeAutomation-Config use `develop`); the broader convention question is
raised in #340.

## Findings note (context, see #341)

The `#16` audit block was stale: the `CODEGEN_APP_*` secrets were
already present in both stores and develop was already ahead of main.
Only the `repo-config/... absent` LETTER finding was real, and it is now
cleared on `main` by PR `#17`.

Validation: `jq` parses clean, `spec/validate.py` -> "21 cataloged, 0
backlog repos classify cleanly."

🤖 Generated with [Claude Code](https://claude.com/claude-code)

---------

Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants