docs: make the plugin the only documented install

john commented

2026-07-31 20:43:10 +00:00

Owner

Install is the two marketplace commands and nothing else. Drops the copy-burnrate.py opening, the direct-python command block, the skill-helper-from-a-clone block and the verify-a-copy section. Troubleshooting no longer tells a plugin user to pass flags they cannot type. The logger extra keeps its clone.

john added 2 commits

2026-07-31 20:43:11 +00:00

docs: make the plugin the only documented install 67f86785e5

The README opened with "copy burnrate.py anywhere and run it" and offered
three ways in, two of which needed a clone. That is not how anyone is meant
to get this: the marketplace install carries the tool with it.

Install is now the two plugin commands and nothing else. Running it is the
/burnrate word and question forms. The direct-python and skill-helper
sections are gone, and the duplicate install block under the old
"/burnrate skill" heading collapses into "Updating, disabling and removing".

Troubleshooting no longer tells a plugin user to pass flags they have no
way to type, the report location now names the cache directory instead of
"next to burnrate.py", and the flags table says up front that it exists to
give the window words a precise meaning.

The logger extra keeps its clone, since you run that installer yourself.

docs: drop the verify-a-copy section df429d7252

It ran tools/selftest.py, which only means anything to someone who cloned
the repo. That belongs with the contributor docs, not in a README whose
install path is a plugin.

john merged commit bbed535ff1 into main

2026-07-31 20:43:25 +00:00

john referenced this pull request from a commit

2026-07-31 20:43:26 +00:00

Merge pull request 'docs: make the plugin the only documented install' (#2) from docs/plugin-only-install into main

Rows
Columns

docs: make the plugin the only documented install #2