Skip to content

docs: cut the README down to the skills essentials - #112

Merged
kpal81xd merged 2 commits into
mainfrom
docs/shorten-readme
Oct 12, 2026
Merged

kpal81xd merged 2 commits into
mainfrom
docs/shorten-readme

Conversation

@kpal81xd

@kpal81xd kpal81xd commented Oct 12, 2026 •

Copy link
Copy Markdown
Collaborator

Cuts the root README from 251 to 127 lines so it is as lean as the playcanvas/skills README. It keeps the same badges and section order.

  • Install: the Claude Code command, the Node requirement and the once-per-agent note. One collapsible block holds the shared JSON for Claude Desktop, Cursor and a project .mcp.json; another holds Codex. Connecting the Editor, the Chrome permission and --port are one paragraph.
  • Removed: the Why section and the transfer, envelope and runtime API paragraphs, which agents get from the tool descriptions.
  • Tools: category and coverage only (no list of 125 tool names), plus a three-line scope note.
  • Context cost and Data and network use: one short paragraph each, with the same facts.
  • Contributing: one code block and two sentences.
  • plugin/README.md: its port link now points to #install, because the Custom port heading is gone. Strict plugin validation and the pin check still pass.

Smoke test

  1. Open the README on the PR branch on GitHub. It shows the badges, then Install, Usage, Tools, Context cost, Data and network use, Contributing and License, with no Why section.
  2. Expand both install blocks. One shows the shared JSON with Desktop, Cursor and Windows notes; the other shows the Codex command.
  3. Open plugin/README.md and follow its "main README" link. It lands on Install, which mentions --port.

@kpal81xd kpal81xd changed the title docs: trim the README docs: cut the README down to the skills essentials Oct 12, 2026
@kpal81xd
kpal81xd merged commit 4f9d64d into main Oct 12, 2026
4 checks passed
@kpal81xd
kpal81xd deleted the docs/shorten-readme branch October 12, 2026 15:09
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