Skip to content

docs: rewrite README for discoverability#14

Merged
Schr0d merged 1 commit into
mainfrom
docs/rewrite-readme-v1.0
Apr 16, 2026
Merged

docs: rewrite README for discoverability#14
Schr0d merged 1 commit into
mainfrom
docs/rewrite-readme-v1.0

Conversation

@Schr0d

@Schr0d Schr0d commented Apr 16, 2026

Copy link
Copy Markdown
Owner

Summary

Rewrote both English and Chinese READMEs to lead with the core question and real terminal output instead of abstract architecture jargon.

Changes:

  • First line: "If I change this file, what breaks?" — a question developers actually search for
  • Added real terminal output examples (impact analysis, diff, full analysis)
  • Added origin story: 1600-line Spring service, 50 @Autowired, tests green, production broke
  • Reorganized: demo → story → quick start → AI agent → languages → architecture
  • Removed abstract jargon ("Structure-Constrained AI Refactoring Pipeline", "closed-loop control system", "bounded transformation")
  • Fixed stale v1.0 roadmap checkbox in Chinese README ([ ][x])
  • Removed stale "实验性 / 早期系统设计" status

Why: The old README was written for people who already knew what Archon does. Nobody searches for "multi-language dependency analysis tool." They search for "what breaks if I change this." Now the first screen answers that.

Test plan

  • Docs-only change, no code modified
  • Both READMEs render correctly on GitHub

🤖 Generated with Claude Code

Lead with the core question ("if I change this file, what breaks?") instead
of abstract architecture jargon. Show real terminal output before explaining
concepts. Fix stale v1.0 roadmap status in Chinese README.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@Schr0d Schr0d merged commit f5c7075 into main Apr 16, 2026
1 check passed
@Schr0d Schr0d deleted the docs/rewrite-readme-v1.0 branch April 16, 2026 13:44
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