Skip to content

docs: reposition project README - #100

Merged
cablate merged 1 commit into
mainfrom
codex/reposition-readme
Sep 26, 2026
Merged

cablate merged 1 commit into
mainfrom
codex/reposition-readme

Conversation

@cablate

@cablate cablate commented Sep 26, 2026

Copy link
Copy Markdown
Owner

Why

The README still presented the project as a feature catalog. New visitors saw badges, tool counts, and a competitor table before understanding why agent location work needs more than a raw API.

What changed

  • open with the orchestration problem this project solves
  • explain observable outcomes and adoption reasons before implementation details
  • present Plugin, CLI, stdio, and HTTP as equal integration choices
  • group the 18 tools by user outcome instead of leading with a long inventory
  • remove the stale competitor matrix and roadmap-heavy framing
  • keep prerequisites, billing, attribution, safety, and credential limits near the decisions they affect
  • fully align the English and Traditional Chinese reader paths
  • update GitHub About description, homepage, and repository topics

Validation

  • Skill validator passed
  • unit tests: 36 passed
  • smoke tests: 114 passed
  • build passed
  • npm pack dry run passed
  • local Markdown links passed

@cablate
cablate merged commit c8f77db into main Sep 26, 2026
2 checks passed
@cablate
cablate deleted the codex/reposition-readme branch September 26, 2026 20:17
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