16 Commits

Author SHA1 Message Date
Adrien Eppling f02f5b1f82 docs: keep the cost breakdown diagram in one place
The tree was copied into 11 files, so every future correction to it meant
11 edits in 7 languages. It now lives only in savings-explained.md, which
each of those pages already links to.

The surrounding prose stays: it carries the dilution point in the reader's
own language, which is the part that matters at a glance. Three pages
introduced the diagram with a trailing colon, reflowed into the following
paragraph. TRACKING.md gained the link it was missing.
2026-07-22 19:23:58 +02:00
Adrien Eppling ead80a3283 docs: name the metric "reduction sortie bash" throughout FEATURES.md
Drop the 33 standalone "**Economies :** ~N%" claims, which asserted a
number with no context next to each command.

Rename the metric everywhere it remains. "Economies" on its own reads as
money saved; the tables measure bash output bytes removed. Column headers,
the section heading and its anchor, the rtk gain description, the telemetry
field list and the category summary now all say so explicitly.
2026-07-22 19:16:10 +02:00
Adrien Eppling c1f6ede36e docs: show the cost breakdown as containment, not a transformation chain
The arrow diagram read as a pipeline where bash output becomes input tokens
which become cost. The real relationship is containment: bash output is
part of input tokens, and input tokens are part of cost alongside output
tokens.

Replace the arrow chain with a tree in all 12 places it appeared, including
the six translated READMEs:

  Cost
  ├─ Input tokens
  │  ├─ Bash output           <- the only part RTK filters
  │  ├─ Your prompt
  │  ├─ System prompt
  │  └─ Conversation history
  └─ Output tokens            <- what the model writes

This also makes the dilution self-evident: RTK shrinks one leaf, so the
effect on the root is bounded by that leaf's share.
2026-07-22 18:52:34 +02:00
Adrien Eppling a1673f7428 docs: scope savings claims to bash output and document the estimator
RTK was documented as delivering "60-90% token savings", which reads as a
cost reduction. What RTK actually reduces is bash output bytes. Those are
one contributor to input tokens, which are themselves only part of a bill
that also counts output tokens, so the reduction dilutes at every step.

- add docs/guide/resources/savings-explained.md as the canonical explainer:
  the savings chain, both estimators, and what RTK does not reduce
- rescope the headline claim across README (7 languages), the guide, hook
  rules, agent definitions and module READMEs
- relabel per-command tables as bash output reduction, keeping every figure
- document that reported tokens are estimates: rtk gain uses bytes/4
  (src/core/tracking.rs), filter tests use split_whitespace().count().
  Neither is a real tokenizer, so ratios hold but absolute counts do not

Remove figures that had no source: the $3/Mtok constant and its $36
example, the +/-10% tokenization accuracy claim, the 99.5% hook-install
figure, the invented session tables in README and INSTALL, and the 30-50%
parser range.

CHANGELOG is untouched. Shipped release notes stay as a historical record.
2026-07-22 18:33:54 +02:00
Adrien Eppling 8c7f0dc97f docs(install): pin cargo install to the master release branch 2026-07-20 16:58:58 +02:00
aesoft 492aa76ed3 Merge pull request #1009 from KuSh/broken-pnpm-i
fix(pnpm): install don't take a list of packages
2026-05-03 16:46:49 +02:00
Joshua 021827c3c9 fix(grep): adjust the command to fall through if the output would already be as small as possible 2026-04-25 20:38:33 -05:00
aesoft e3149cb7fb Merge pull request #1056 from vzwjustin/develop
feat(gains): add --reset flag
2026-04-21 19:00:59 +02:00
Joshua 80bc7fbd61 documentation 2026-04-15 14:45:30 -05:00
aesoft 9e96caa0a1 Merge pull request #355 from KuSh/pnpx+dlx
feat(discover): handle more npm/npx/pnpm/pnpx patterns
2026-04-13 20:31:12 +02:00
Nicolas Le Cam 45938b2a4d feat(js): distinguish between jest and vitest and don't rewrite npm test commands as we don't know which test framework is used under the hood
Signed-off-by: Nicolas Le Cam <niko.lecam@gmail.com>
2026-04-12 22:03:39 +02:00
Nicolas Le Cam 9a50efadc3 fix(pnpm): install don't take a list of packages
Signed-off-by: Nicolas Le Cam <niko.lecam@gmail.com>
2026-04-11 17:31:10 +02:00
aesoft 6a5bc847e0 fix(telemetry): RGPD-compliant, consent gate, erasure, privacy controls
+ docs update
2026-04-10 16:04:08 +02:00
Justin Adams 3f15b89227 Merge branch 'develop' into develop 2026-04-08 17:54:07 -05:00
Claude 4db7e86c26 docs: add --reset/--yes flags to docs/usage/AUDIT_GUIDE.md
Adds reset flag documentation to the upstream file path:
- Quick Reference: reset usage examples with and without --yes
- Command Options: Reset Flag table with --reset and --yes descriptions
- Warning note about irreversibility and non-interactive behaviour

https://claude.ai/code/session_015WXbDdxEU3pXPBtheDkXcd
2026-04-08 22:51:55 +00:00
aesoft deda44f736 fix(docs): clean some docs + disclaimer 2026-04-02 21:33:38 +02:00