docs: README visibility overhaul — problem-first hook, dashboard hero, MCP quickstart - #77
Open
TheAmericanMaker wants to merge 1 commit into
Open
docs: README visibility overhaul — problem-first hook, dashboard hero, MCP quickstart#77TheAmericanMaker wants to merge 1 commit into
TheAmericanMaker wants to merge 1 commit into
Conversation
…, Why section, MCP quickstart - Rewrite README opening for the 5-second test: lead with the problem (understand an unfamiliar codebase + get a validated spec), drop 'cartography' from line 1, name the supported agents up front. - Add a real dashboard screenshot (docs/demo-dashboard-hero.png) as a hero image. Generated from a hand-authored demo workspace via the real writeDashboard() renderer — no LLM run needed. Build script: scripts/build-demo-dashboard.mjs (gitignored output). - Add a 'Why CodeCartographer' section: filesystem-as-memory, validated phases, spec-not-chatlog output. - Add a 'star if you use it' nudge to convert the existing install base into social signal. - Add docs/mcp-quickstart.md — 30-second setup for Claude Code, Cursor, Codex, Claude Desktop, opencode. Linked prominently from the README install section. - Add docs/visibility-roadmap.md for the user's later review (documents what was done tonight + what still needs the user). - Gitignore the demo workspace + non-hero screenshots (build artifacts); commit only the hero PNG and the build script. - GitHub repo topics updated (codebase, ai-agent, context-engineering, code-understanding, spec-driven) — done via gh, not in this commit. Tests: 270/270 pass. Build: clean.
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.
What
The product has real adoption (~1,800 npm installs/month) but almost no social signal (1 GitHub star). People install and leave without starring or talking about it. This PR closes the discoverability + conversion gap — it is a marketing problem, not a quality problem.
Changes
docs/demo-dashboard-hero.png). Generated from a hand-authored demo workspace via the realwriteDashboard()renderer — no LLM run needed. Build script:scripts/build-demo-dashboard.mjs(output gitignored except the hero PNG).docs/mcp-quickstart.md: 30-second setup for Claude Code, Cursor, Codex, Claude Desktop, opencode. Linked prominently from the README install section.docs/visibility-roadmap.md: documents what was done tonight + what still needs the user (real LLM run, case study, codecarto.dev, demo video, starter library). For later review..gitignore: demo workspace + non-hero screenshots gitignored as build artifacts.Verification
Not in this PR (done separately / needs user)
gh repo edit(already applied to the repo, not a commit): addedcodebase,ai-agent,context-engineering,code-understanding,spec-driven(was 7 topics, now 12).See
docs/visibility-roadmap.mdfor the full list of follow-ups.