README overhaul — MCP URL first, clear getting-started path#70
Merged
Conversation
Joshua's feedback: both READMEs need clear bootstrapping instructions. Old README led with CLI commands and 'librarian' terminology. New README: - Leads with MCP URL and four platform connection paths - Current tool table (orient, search, challenge, gate, encode, etc.) - Example prompts to try immediately - Bootstrap and permissions guidance - 'Point at your own repo' section - Links to Getting Started, Journey, and From Passive to Proactive - Cross-links klappy.dev knowledge base repo
Deploying with
|
| Status | Name | Latest Commit | Preview URL | Updated (UTC) |
|---|---|---|---|---|
| ✅ Deployment successful! View logs |
oddkit | 8f16edf | Commit Preview URL Branch Preview URL |
Apr 04 2026, 12:50 AM |
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
1 participant
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.
Joshua's feedback: both READMEs need clear bootstrapping instructions.
Old README led with CLI commands and "librarian" terminology. New README:
Companion to klappy.dev PR #72 (E0007 articles + README overhaul).
Note
Low Risk
Documentation-only rewrite; low risk aside from potentially confusing setup if the MCP URL/instructions are incorrect.
Overview
Rewrites
README.mdto lead with remote MCP server onboarding (singlehttps://oddkit.klappy.dev/mcpURL) and provides quick connection steps for Claude.ai, ChatGPT, Claude Code/Cursor, and other MCP clients.Replaces the prior CLI-command-centric framing with a current tool capability table (
orient,search,challenge,gate,encode, etc.), adds example prompts, and includes guidance for making oddkit proactive via project bootstrap instructions.Adds docs on pointing oddkit at a different GitHub knowledge base via
canon_url, refreshes the high-level architecture/development notes, and updates “Learn more” links.Reviewed by Cursor Bugbot for commit 8f16edf. Bugbot is set up for automated code reviews on this repo. Configure here.