Skip to content

docs(readme): restore the title heading and drop the duplicate intro - #12

Merged
andybons merged 1 commit into
mainfrom
andybons/readme-family-fixes
Sep 28, 2026
Merged

andybons merged 1 commit into
mainfrom
andybons/readme-family-fixes

Conversation

@andybons

Copy link
Copy Markdown
Contributor

The README leads with an ANSI wordmark block and no H1, so screen readers and outline navigation get no document title.

This adds # Keep above the wordmark block, matching the Charm convention of title then logo.

It also drops the old intro paragraph at line 19, which restated the header tagline almost word for word; the tagline stays as the single source of that sentence.

Same fix as majorcontext/moat#471, majorcontext/gatekeeper#74, and majorcontext/harness#350.

Copilot AI balanced review requested due to automatic review settings September 28, 2026 22:25
@claude

claude Bot commented Sep 28, 2026 •

Copy link
Copy Markdown

Claude finished @andybons's task in 8s —— View job


Review

This looks good. I found no issues.

  • # Keep is now the only H1, and the rest of the README uses ## and below, so the heading hierarchy is fine.
  • The removed intro paragraph was a near-duplicate of the tagline at line 15. The tagline still covers the same points (deny, redact, log, before reaching upstream). The next paragraph still explains the library, gateway and relay modes, so the flow reads correctly.
  • I checked the rest of the README for links or anchors that pointed at the removed paragraph and found none.

This is a docs-only change, so I didn't run any tests.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot review overview

🟢 Approval recommended

The focused documentation changes correctly improve accessibility and clarity.

Review effort: Balanced
Findings: None

What changed in this PR

Adds an accessible document title and removes redundant introductory text.

Changes:

  • Adds # Keep before the ANSI wordmark.
  • Removes the paragraph duplicating the tagline.
File Description
README.md Improves heading navigation and eliminates duplicated copy.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

@andybons
andybons merged commit 6a65cd2 into main Sep 28, 2026
5 checks passed
@andybons
andybons deleted the andybons/readme-family-fixes branch September 28, 2026 22: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