docs: strip em dashes, fill the banner alt, use the house H1 - #43
Merged
Conversation
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
This PR updates repository and package documentation to match the project’s “house” style while improving accessibility for the repository banner image.
Changes:
- Adds meaningful alt text to the root README banner image and updates the root H1 to
# uinaf/react-json-logic. - Replaces remaining em dashes in docs with house-preferred punctuation (semicolons/colons) and clarifies one table placeholder value.
- Makes small wording tweaks in the package README for consistency (e.g., “Sample data, used by …”).
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| README.md | Adds non-empty banner alt text and updates the repository H1 to the house form. |
| packages/react-json-logic/README.md | Replaces em dashes with semicolons and updates one table placeholder/default wording. |
| AGENTS.md | Replaces em dashes with house-preferred punctuation in layout/conventions text. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
There was a problem hiding this comment.
⚡ SLOPS ZAPPED: 1
Verdict: Non-blocking slop
The punctuation and H1 edits are harmless. The filled banner alt undoes the empty-alt treatment and repeats the heading for assistive tech.
Findings
- 🫧 NITSLOP · P3 — Banner alt restates the heading — reckless a11y revert (
README.md:1)
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
26 tasks
|
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
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.
Problem
The banner image has empty alt text, the H1 (
# react-json-logic) misses the house form, and 8 em dashes sit across AGENTS.md and the package README (one as a bare table placeholder).Solution
react-json-logic — build and evaluate JsonLogic with React components.(the one sanctioned em dash).# uinaf/react-json-logic; clauses take semicolons; the default-column placeholder readsnone.Part of the house gauntlet (ffsstack#53).
🤖 Generated with Claude Code