Skip to content

docs: say which of the three Nhimbe repos this is, and drop links to untracked files - #134

Merged
bryanfawcett merged 1 commit into
mainfrom
docs/readme
Sep 11, 2026
Merged

bryanfawcett merged 1 commit into
mainfrom
docs/readme

Conversation

@bryanfawcett

Copy link
Copy Markdown
Contributor

Nhimbe, mukoko-events-admin and mukoko-events-mcp are three repos for one
product, and none of the three READMEs said which piece it was. Added a table:
this repo is the public app AND the data plane — the Next.js app, the MongoDB
layer, the /api/events* REST surface and the .well-known documents the MCP's
OAuth challenge points clients at. The admin app and the MCP server are named
with their own domains. Noted what this repo does NOT contain: no src/app/admin
(it 307s to admin.events.mukoko.com) and no wrangler.toml.

Broken links removed. The README linked ./CLAUDE.md three times and
./.claude/skills/ once. Commit 5ce74ca untracked both, so all four links 404 on
a fresh clone — including the sentence sending readers to CLAUDE.md for the
environment-variable list, which actually lives in .env.example. Repointed at
.env.example, AGENTS.md and docs/, and said plainly that CLAUDE.md and .claude/
are untracked local conveniences.

The dual-domain fact was missing entirely. Both events.mukoko.com and
nhimbe.com serve the app; events.mukoko.com is the canonical primary that every
self-referential URL points at (src/lib/site-url.ts). The README named only
nhimbe.com. Live badge and header now lead with the primary and list both.

Removed two committed model identifiers from the stack section — AGENTS.md
forbids putting them in code, commits or docs, and the README was breaking its
own repo's rule.

Dropped the hardcoded "~682 tests" count, which drifts on every commit, and
added the integration-test script the Quickstart omitted. Added the CI badge
(curled: 200 — this repo is public).

Co-Authored-By: Claude Opus 5 (1M context) noreply@anthropic.com

…untracked files

Nhimbe, mukoko-events-admin and mukoko-events-mcp are three repos for one
product, and none of the three READMEs said which piece it was. Added a table:
this repo is the public app AND the data plane — the Next.js app, the MongoDB
layer, the /api/events* REST surface and the .well-known documents the MCP's
OAuth challenge points clients at. The admin app and the MCP server are named
with their own domains. Noted what this repo does NOT contain: no src/app/admin
(it 307s to admin.events.mukoko.com) and no wrangler.toml.

Broken links removed. The README linked ./CLAUDE.md three times and
./.claude/skills/ once. Commit 5ce74ca untracked both, so all four links 404 on
a fresh clone — including the sentence sending readers to CLAUDE.md for the
environment-variable list, which actually lives in .env.example. Repointed at
.env.example, AGENTS.md and docs/, and said plainly that CLAUDE.md and .claude/
are untracked local conveniences.

The dual-domain fact was missing entirely. Both events.mukoko.com and
nhimbe.com serve the app; events.mukoko.com is the canonical primary that every
self-referential URL points at (src/lib/site-url.ts). The README named only
nhimbe.com. Live badge and header now lead with the primary and list both.

Removed two committed model identifiers from the stack section — AGENTS.md
forbids putting them in code, commits or docs, and the README was breaking its
own repo's rule.

Dropped the hardcoded "~682 tests" count, which drifts on every commit, and
added the integration-test script the Quickstart omitted. Added the CI badge
(curled: 200 — this repo is public).

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@vercel

vercel Bot commented Sep 11, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
nhimbe Ready Ready Preview Sep 11, 2026 7:53pm UTC

Request Review

@claude claude Bot 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.

Claude Code Review

This repository is configured for manual code reviews. Comment @claude review for a one-time review, or @claude review always to subscribe this PR to a review on every future push.

Tip: disable this comment in your organization's Code Review settings.

@claude

claude Bot commented Sep 11, 2026

Copy link
Copy Markdown

Claude encountered an error —— View job


I'll analyze this and get back to you.

@bryanfawcett
bryanfawcett added this pull request to the merge queue Sep 11, 2026
Merged via the queue into main with commit c80fc99 Sep 11, 2026
19 checks passed
@bryanfawcett
bryanfawcett deleted the docs/readme branch September 11, 2026 20:04
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.

1 participant