Skip to content

docs: revamp GitHub repository presentation - #1

Merged
hepinga merged 1 commit into
mainfrom
codex/github-repo-makeover
Jul 19, 2026
Merged

docs: revamp GitHub repository presentation#1
hepinga merged 1 commit into
mainfrom
codex/github-repo-makeover

Conversation

@hepinga

@hepinga hepinga commented Jul 18, 2026

Copy link
Copy Markdown
Collaborator

Outcome

Turns the repository homepage into a bilingual, product-led GitHub surface while keeping release claims accurate.

  • makes English the default README and adds a reciprocal Simplified Chinese README
  • adds factual badges, download/website/privacy entry points, a real product gallery, wide hero, and 1280×640 social preview asset
  • documents the research, official GitHub guidance, information architecture, Topics, labels, and launch checklist
  • adds bilingual Issue forms, Issue routing, a PR template, and a reviewable label manifest
  • explicitly keeps v0.9.0 as the current public Release and describes v0.10 content as unreleased preview work
  • does not add a Homebrew command because the existing macpulse cask belongs to a different product

Privacy and screenshot boundary

The app images were captured from the isolated build with privacy aliases enabled. Credentials, private paths, admin surfaces, and unavailable-service states were excluded. Inaccessible transient Skills/notch surfaces were not fabricated; the research document records the safe recapture follow-up.

Verification

  • ./scripts/build.sh 0.10.0 3 (isolated worktree; build succeeded)
  • global github-repo-makeover audit: 15/15 checks, PASS 100/100
  • reciprocal README links and 28 local README targets verified
  • all Issue/label YAML parsed successfully
  • git diff --check
  • social preview: 1280×640, 76,064 bytes
  • forward test against a minimal fixture: required failures produce BLOCKED, capped score, and nonzero --strict exit

This PR does not modify Swift product logic, publish v0.10, install over /Applications, or merge itself.

@hepinga
hepinga merged commit 62d7d7e into main Jul 19, 2026
2 checks passed
@hepinga
hepinga deleted the codex/github-repo-makeover branch July 19, 2026 12:43
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.

1 participant