docs: rewrite the README to describe the repository that exists - #95
Open
Bryan Fawcett (bryanfawcett) wants to merge 1 commit into
Open
Bryan Fawcett (bryanfawcett) wants to merge 1 commit into
Bryan Fawcett (bryanfawcett) wants to merge 1 commit into
Conversation
The README described a 15-app super app with a Flutter shell, a live token
economy and a Next.js marketing site in web/. None of that is in the tree.
What is actually here, and what the README now says:
- mini-apps/ holds six Preact mini-apps - clips, connect, events, novels,
pulse, weather - plus _template. Each is a single screen that renders a
heading and one line of copy. The old list (Campfire, Mukoko News, Bytes,
Circles, Nhimbe, BushTrade, Mukoko Lingo, Transport, Mukoko Wallet) named
nine directories that do not exist.
- The repository description names six apps: ID, Clips, Pulse, Connect,
Novels, Events. Five are the mini-apps above. ID is not a mini-app - it is
services/id-api, and the identity product that ships is mukoko-dev/mukoko-auth
at id.mukoko.com. Weather is a seventh mini-app the description omits. The
README now says all three of those things.
- services/ holds six Hono workers plus _template. Every route handler returns
{"message": "TODO: Implement ..."}. No worker declares a route or custom
domain, so none of this is deployed. The README now leads with that rather
than burying it.
- honey/ is a FastAPI service (package nuchi-honey 0.1.0) serving /health and
/ only; models/, routes/ and services/ are empty directories.
- web/ was stubbed in #83; the marketing site moved to bundu-labs/marketing
and was rebuilt in Astro 6. web/MIGRATED.md is now linked instead of the
README claiming web/ is a Next.js 15 site you can develop in.
- The Flutter app/ directory was removed in #75. The README still documented
it in the repo-structure tree and in the prerequisites table.
- packages/ names were wrong: the directories are design-system, bridge-sdk,
api-client, types, eslint-config and tsconfig, publishing @mukoko/ui,
@mukoko/bridge, @mukoko/api and @mukoko/types.
Dead links removed:
- assets.nyuchi.com 404s.
- status.mukoko.com has no DNS record at all.
- The clone URL was github.com/nyuchitech/mukoko; that org redirects, but the
canonical URL is mukoko-dev/mukoko and is now used directly.
- The licence section linked ./LICENSE. No LICENSE file is committed. The
section now says so plainly instead of linking a file that isn't there.
Added a CI badge (the workflow runs on push and PR to main) and five stack
badges; all six resolve.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Bryan Fawcett (bryanfawcett)
enabled auto-merge (rebase)
September 11, 2026 20:04
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.
The README described a 15-app super app with a Flutter shell, a live token
economy and a Next.js marketing site in web/. None of that is in the tree.
What is actually here, and what the README now says:
pulse, weather - plus _template. Each is a single screen that renders a
heading and one line of copy. The old list (Campfire, Mukoko News, Bytes,
Circles, Nhimbe, BushTrade, Mukoko Lingo, Transport, Mukoko Wallet) named
nine directories that do not exist.
Novels, Events. Five are the mini-apps above. ID is not a mini-app - it is
services/id-api, and the identity product that ships is mukoko-dev/mukoko-auth
at id.mukoko.com. Weather is a seventh mini-app the description omits. The
README now says all three of those things.
{"message": "TODO: Implement ..."}. No worker declares a route or custom
domain, so none of this is deployed. The README now leads with that rather
than burying it.
/ only; models/, routes/ and services/ are empty directories.
and was rebuilt in Astro 6. web/MIGRATED.md is now linked instead of the
README claiming web/ is a Next.js 15 site you can develop in.
it in the repo-structure tree and in the prerequisites table.
api-client, types, eslint-config and tsconfig, publishing @mukoko/ui,
@mukoko/bridge, @mukoko/api and @mukoko/types.
Dead links removed:
canonical URL is mukoko-dev/mukoko and is now used directly.
section now says so plainly instead of linking a file that isn't there.
Added a CI badge (the workflow runs on push and PR to main) and five stack
badges; all six resolve.
Co-Authored-By: Claude Opus 5 (1M context) noreply@anthropic.com