Skip to content

chore: align badges and description to brand#5

Closed
amcheste-ai-agent[bot] wants to merge 2 commits into
mainfrom
chore/brand-alignment
Closed

chore: align badges and description to brand#5
amcheste-ai-agent[bot] wants to merge 2 commits into
mainfrom
chore/brand-alignment

Conversation

@amcheste-ai-agent
Copy link
Copy Markdown

Summary

Aligns the two brand surfaces this repo had wrong: the README badge stack (was missing entirely) and the GitHub repo description (had an em-dash). PR is intentionally tiny so review is trivial; the README body em-dash sweep is deferred to a follow-up so the diffs stay separable.

What changed

  • License badge — Hunter Green (#1F4D3A), the CAM family-system accent for license badges, linking to LICENSE.
  • Version badge — Ink (#0B0B0C), the structural metadata color, linking to CHANGELOG.md. Value reflects the VERSION file added in chore: add community files #4.
  • Python badge — Ink (#0B0B0C), reflecting the 3.11+ floor already documented under Prerequisites.
  • GitHub repo description — applied via gh repo edit (not part of this diff, but live on the repo). Changed:
    • Was: AI Golf Coach Agent — downloads Rapsodo MLM2PRO sessions from R-Cloud and delivers focused coaching reports using Vision LLM swing analysis
    • Now: AI golf coach agent. Downloads Rapsodo MLM2PRO sessions from R-Cloud and delivers focused coaching reports using Vision LLM swing analysis.

Cross-references

Out of scope

Test plan

  • Rendered License badge is Hunter Green on the PR's README preview.
  • Rendered Version badge is Ink (near-black) and reads version | 0.1.0.
  • Rendered Python badge is Ink and reads python | 3.11+.
  • gh repo view amcheste/golf-coach-agent --json description returns the new copy with no em-dash.
  • Diff contains exactly one block: the four-line badge insertion under the # Golf Coach Agent title.

Aligns the README badge stack and the GitHub repo description with
the CAM family brand system.

- License badge uses Hunter Green (#1F4D3A), the family-system accent
  for license badges, and links to the in-repo LICENSE.
- Version badge uses Ink (#0B0B0C), the structural metadata color, and
  links to CHANGELOG.md. Value reflects the new VERSION file.
- Python badge uses Ink (#0B0B0C) and reflects the 3.11+ floor already
  documented in Prerequisites.
- GitHub repo description (applied separately via `gh repo edit`)
  drops the em-dash for a period+capital, per brand voice.

Mirrors precedents in repo-template PR #8, mac-dev-setup PR #78,
engineering-handbook PR #15, and overleaf-mcp's badge stack.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Co-Authored-By: amcheste <13696614+amcheste@users.noreply.github.com>
@amcheste-ai-agent amcheste-ai-agent Bot requested a review from amcheste as a code owner May 6, 2026 03:28
amcheste added a commit that referenced this pull request May 6, 2026
## Summary

Closes the last item from the brand audit's "missing brand infrastructure" list. Adds a header banner so the README has a visual identity that matches the rest of the CAM family (mirrors the `overleaf-mcp` pattern of a `docs/images/banner.png` referenced from the top of the README via centered HTML).

## Design

| Property | Value |
|---|---|
| Dimensions | 1200 × 400 (rendered at `width="800"` in the README) |
| Background | Ink (`#0B0B0C`), the CAM structural color |
| Title | "Golf Coach Agent", white, Helvetica/Arial 84px bold |
| Accent rule | Hunter Green (`#1F4D3A`), 64×4px under the title |
| Tagline | "AI swing analysis from Rapsodo MLM2PRO sessions.", light gray |
| Brand-voice line | "One flaw, one drill, one target metric.", Hunter Green |

Brand voice line is the same one PR #6 cleaned up in the README intro, so the banner reinforces it.

## Files

- `docs/images/banner.svg` — source. Editable, version-controlled, easy to re-render.
- `docs/images/banner.png` — output of `rsvg-convert -w 1200 -h 400 -o docs/images/banner.png docs/images/banner.svg`. Rendering instructions live alongside the source in case it ever needs a tweak.
- `README.md` — adds a centered `<p>` block with the banner above the existing `# Golf Coach Agent` title.

## Cross-references

- Precedent: [`overleaf-mcp`](https://github.com/amcheste/overleaf-mcp/blob/main/README.md) (centered banner above title, `docs/images/banner.png`).
- Brand colors: `alanchester-brand` repository.

## Test plan

- [ ] Banner renders inline in the PR's README preview, scaled to 800px wide.
- [ ] Re-running `rsvg-convert -w 1200 -h 400 -o docs/images/banner.png docs/images/banner.svg` from a clean checkout reproduces the committed PNG (within file metadata variance).
- [ ] No clash with badges from #5 (banner sits above the H1, badges sit below it).
amcheste added a commit that referenced this pull request May 6, 2026
## Summary

Final pass in the brand-alignment sequence (after #4 community files and #5 badges/description). Brings the README prose into alignment with the CAM brand voice rule against em-dashes. Three removed, two preserved by design.

## Counts

- **Em-dashes in README on `main` before this PR:** 5
- **Removed:** 3 (in the repo's own prose)
- **Preserved:** 2 (inside the Sample Coaching Report block)

## Removals

| Location | Before | After | Pattern |
|---|---|---|---|
| Intro paragraph | `coaching report — one flaw, one drill, one target metric.` | `coaching report. One flaw, one drill, one target metric.` | Period + capital. The list stands alone as its own sentence. |
| Setup §3 | `This saves` `config/storage_state.json` `— your session token.` | `This saves` `config/storage_state.json` `, your session token.` | Comma. The phrase is an appositive defining the file. |
| Output (after vault tree) | `gitignored — videos and images stay local.` | `gitignored. Videos and images stay local.` | Period + capital. Two complete clauses. |

## Preserved (intentional)

The two em-dashes in the **Sample Coaching Report** block (lines around the `## The Prescription` and `## Historical Context` sections of that example) are the agent's own output, not the repo's prose. The README's job there is to faithfully show what the tool emits; rewriting them would misrepresent the tool. This mirrors the same kind of preservation rule used in [`alanchester-brand` #6](amcheste/alanchester-brand#6) (proper nouns, intentional voice, technical content).

## Untouched (per the procedure)

- All code blocks (Python, bash, `.env` template).
- The ASCII architecture diagram.
- File paths, tool names, and the `rapsodo_vault/` directory tree.

## Post-sweep audit

`grep -n "\. [a-z]" README.md` returned **no matches**, so no mechanical capitalization artifacts were introduced.

## Test plan

- [ ] `grep -c "—" README.md` returns `2`, both inside the Sample Coaching Report block.
- [ ] Rendered README on the PR preview reads naturally at the three rewritten spots.
- [ ] No code blocks, the architecture diagram, or the directory tree were modified.
PR #5's original scope (license/version badge colors) was superseded
by the subsequent brand-alignment work that landed on main via PRs
#4#11 (banner, centered layout, scorecard badge, dynamic version
badge, em-dash cleanup). Main's README is already brand-aligned.

The only original-to-PR-#5 addition was the Python version badge,
which isn't a pattern shared by other Python repos in the family
(market-lens, niche-hunter, overleaf-mcp also don't carry one).
Drop it for family consistency. If desired, add it later in a
dedicated PR.

Resolve by taking main's README. The PR effectively becomes a no-op
merge — close-as-superseded or fast-forward, either works.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Co-Authored-By: amcheste <13696614+amcheste@users.noreply.github.com>
@amcheste-ai-agent
Copy link
Copy Markdown
Author

Closing as superseded. The brand-alignment work this PR proposed (license badge → #1F4D3A, version badge → #0B0B0C) landed on main via PRs #4#11 in a more comprehensive form: full badge stack including CI and Scorecard, banner image, centered layout, dynamic version badge from GitHub tags, em-dash sweep across prose.

After merging main into this branch and resolving the README conflict by taking main's version, the PR diff dropped to 0 files changed — there's nothing left here that isn't already on main.

The one original-to-this-PR addition was the Python version badge (python-3.11+-0B0B0C). Dropped for family consistency — none of the other Python repos in the family (market-lens, niche-hunter, overleaf-mcp) carry a Python badge. If desired later, it's a one-line follow-up PR against develop (per the new branch model: every change lands on develop first).

@amcheste amcheste deleted the chore/brand-alignment branch May 12, 2026 02:31
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