docs: readme polish - #98
Merged
Merged
Conversation
hesreallyhim
commented
Sep 10, 2026
hesreallyhim
commented
Member
- Revise README language and structure
- Add explanatory graphics
Show the twelve badges as rendered artifacts served for this repository, rather than describing them in prose. Columns split on API scope (repository-level endpoints vs. default-branch rulesets), mirroring the REST source column in Supported checks. Each badge links to its details.json record. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Replace the bare Settings UI screenshot with a composite that puts the admin-only checkbox next to the public PolicyChecks badge that mirrors it (light and dark variants). Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
The mermaid diagram described a 'GitHub App installation token' step and had no branch for authentication failures. The new graphic follows the code: cache check, GitHub App auth + installation lookup, one REST call per badge, and every failure branch (not installed, auth rejected, rate limited, inconclusive) collapsing to unknown. Light and dark variants. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Both images now use large type relative to their width so they stay readable in the GitHub mobile app. The settings screenshot is sliced at a word gap and wrapped to two lines; the flowchart is laid out vertically and embedded at 600px so desktop shows it at natural size. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Bigger edge labels and stacked fallback phrases on the flowchart, larger eyebrow and connector text on the side-by-side image, padded badge chips, and the served-as footnote removed from the flowchart. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Move the setting-vs-badge and how-it-works generators out of the private scratch folder, split shared pieces (themes, Octicons, badge rendering, rsvg wrapper) into common.py, and document every knob. render-badges.ts feeds the real badge SVGs to both scripts. Badge chips get extra right padding to compensate for rsvg ignoring textLength. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Deploying with
|
| Status | Name | Latest Commit | Preview URL | Updated (UTC) |
|---|---|---|---|---|
| ✅ Deployment successful! View logs |
policychecks | 6707d04 | Commit Preview URL Branch Preview URL |
Sep 10 2026, 04:05 PM |
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 free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.