Skip to content

docs(readme): adopt the shared Major Context header and footer - #74

Merged
andybons merged 2 commits into
mainfrom
andybons/readme-family
Sep 28, 2026
Merged

andybons merged 2 commits into
mainfrom
andybons/readme-family

Conversation

@andybons

Copy link
Copy Markdown
Contributor

This is a cosmetic change, part of a family-wide README header/footer pass across the five Major Context repos (Moat, Keep, Gatekeeper, Bailey, Harness).

The badge row now follows the shared order: CI, Go Reference, License. There is no Release badge yet since this repo has no releases.

A shared footer was added linking the other four sibling repos, with Gatekeeper itself shown in bold instead of linked. The tiny standalone License section was removed since its content now lives in the footer's "MIT licensed. See LICENSE" line.

The Bailey link in the footer resolves once majorcontext/bailey goes public, which is why this PR is held until then — please don't merge it yet.

READMEs across the Major Context repos (Moat, Keep, Gatekeeper,
Bailey, Harness) currently look inconsistent, with no shared
identity or cross-links between sibling projects.

Give this README the shared header (ANSI Shadow wordmark, one-line
tagline, and a badge row for CI, Go Reference, and License) and a
shared footer linking the other four repos. No releases exist yet,
so the Release badge is omitted. The tiny standalone License section
is now redundant with the footer's MIT line and is removed; every
other section is untouched.

Verified with a link-check script confirming every relative link
resolves to a real file and every github.com/majorcontext/* link
points at one of the five family repos. No markdownlint or README
lint step exists in this repo to run.
Copilot AI balanced review requested due to automatic review settings September 28, 2026 22:05
@claude

claude Bot commented Sep 28, 2026 •

Copy link
Copy Markdown
Contributor
📦 Previous Review (superseded by newer review)

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


PR review: docs(readme): adopt the shared Major Context header and footer

Docs-only change to README.md. It has no security or runtime impact, and I found nothing blocking.

Observations

  • Duplicate intro. The new tagline paragraph (README.md:13) is followed directly by the old intro ("A credential-injecting TLS-intercepting proxy. Route HTTPS traffic through Gatekeeper…"). They say nearly the same thing. Consider dropping the old one, or merging the two.
  • ASCII banner. The banner sits in a text fence, so it renders as monospace. It's about 82 columns wide, so it may wrap or scroll on narrow viewports such as mobile. It also has no text alternative for screen readers, though the tagline right below it partly covers that.
  • Bailey link. The PR description says it will 404 until majorcontext/bailey goes public. Hold the merge until then, as noted.
  • License link. The License section is removed and the footer keeps [LICENSE](LICENSE). The link only works if a LICENSE file exists at the repo root, which I didn't check.

Nothing else to flag. I did not run any tests, since this is a README-only change.

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

🟡 Changes recommended

The update removes the semantic H1 and duplicates the introductory description.

Review effort: Balanced
Findings: 2 Low severity

Open (2)
What changed in this PR

Adopts the shared Major Context README branding and repository footer.

Changes:

  • Adds an ASCII banner and reordered badges.
  • Adds sibling-repository and license links.
  • Removes the standalone license section.
File Description
README.md Updates shared branding, badges, introduction, and footer.

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

Comment thread README.md
Comment thread README.md
@claude

claude Bot commented Sep 28, 2026 •

Copy link
Copy Markdown
Contributor

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


Review of PR #74 (README header/footer)

No blocking issues. This is a docs-only change to README.md, so none of the security, race or proxy-forwarding concerns apply.

Copilot's two findings are already addressed by the latest commit (f78485f):

  • H1: # Gatekeeper is still on line 1, above the ASCII banner, so the document keeps a semantic title.
  • Duplicate intro: The original intro paragraph is replaced by the new summary, not kept next to it. git diff origin/main...HEAD shows one intro paragraph, followed by the badges and "Full documentation".

Checks:

  • The badge links point at ci.yml, pkg.go.dev and LICENSE. I didn't confirm that ci.yml and LICENSE exist in the repo.
  • The footer is bold for Gatekeeper and links the four sibling repos. The Bailey link will 404 until that repo is public. As the PR description says, this is why it's held.
  • Removing the ## License section leaves the license reference only in the footer. Check that nothing links to a #license anchor. I didn't search for one.

Minor: the banner's last line is all trailing spaces. It's harmless inside a code fence.

Please don't merge until Bailey is public.

@andybons
andybons merged commit 3cb4ef1 into main Sep 28, 2026
2 checks passed
andybons added a commit to majorcontext/keep that referenced this pull request Sep 28, 2026
…12)

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.
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