YuShenLiu06/PCHSystem / .claude/skills/beautify-github-readme
beautify-github-readme
VerifiedRedesign GitHub README homepages or create project-native pure SVG, hybrid SVG-composed PNG/WebP, and opt-in animated GIF assets. Use when a user asks to beautify, redesign, rebrand, visually upgrade, simplify, or audit a GitHub README; create only a hero, section headers, diagrams, badges, motion graphics, showcase modules, or other README assets; or turn a repository homepage into a cohesive visual story. If whole-README work versus asset-only work is unclear, ask which scope the user wants. For hero-like assets where pure SVG and generated raster material are both viable, explain the tradeoffs and confirm the implementation before creating the asset.
| File | Kind | Size |
|---|---|---|
| SKILL.md | skill md | 16.0 KB |
| agents/openai.yaml | config | 328 B |
| references/content-architecture.md | markdown | 1.3 KB |
| references/github-readme-canvas.md | markdown | 3.3 KB |
| references/hybrid-svg-production.md | markdown | 4.5 KB |
| references/motion-production.md | markdown | 6.7 KB |
| references/project-native-hero.md | markdown | 5.9 KB |
| references/showcase-contribution.md | markdown | 2.5 KB |
| references/svg-production.md | markdown | 9.9 KB |
| references/visual-direction.md | markdown | 3.6 KB |
| scripts/audit_readme.pyexecutable | script | 2.7 KB |
| scripts/render_motion_gif.pyexecutable | script | 19.3 KB |
references/content-architecture.md
View on GitHub# README content architecture
## The first-screen test
Without scrolling, a new visitor should understand:
1. What is this?
2. What can it do for me?
3. What should I look at next?
The hero should answer the first two. The next module should provide proof.
## Plain-language sequence
Use this sequence unless the repository has a stronger information need:
```text
Value → Proof → Mechanism → First use → Detail
```
Do not begin with architecture, contributor instructions, a command, or a long table of contents when the project is unfamiliar.
## Editing rules
- Replace internal jargon with a concrete outcome.
- Explain the mechanism once; remove repeated versions of the same promise.
- Put the shortest working install path before advanced configuration.
- Keep limitations visible when they affect user choice.
- Prefer one example that succeeds end-to-end over many disconnected snippets.
- Use “we” or direct language when it reduces distance, but do not fake community size.
## Visual-to-text division
Use visuals for hierarchy, identity, comparison, sequence, and proof. Use Markdown for explanation, commands, API details, links, compatibility, and contribution instructions.
If a sentence needs to be copied, searched, translated, or frequently updated, keep it out of SVG.
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| rea-analysis-optimizationmorluto/reaOptimize REA providers and shared analysis workflows for agent context, latency, CPU, and memory while preserving correctness and Evidence. Use for analysis bottlenecks and cache or query design; CI/test-suite optimization belongs to rea-ci-tests-audit. | Stars: 471k | Updated | Claude CodeCodex | Verified | Install |
| rea-ci-tests-auditmorluto/reaAudit REA CI and test suites for correctness, fixture drift, false passes, and measured performance; use for suite or workflow investigations and efficiency changes, rather than ordinary feature testing or a single test failure. | Stars: 471k | Updated | Claude CodeCodex | Verified | Install |
| rea-tool-designmorluto/reaAudit, investigate, design, or change REA investigation tools, CLI/MCP contracts, provider capabilities, and Evidence semantics. | Stars: 471k | Updated | Claude CodeCodex | Verified | Install |
| ponytail-auditDietrichGebert/ponytailQuality audit of the whole repo: bugs, security, real load, missing tests, speed, and what to delete. Most important first. | Stars: 194k | Updated | Claude CodeCodex | Verified | Install |