2f185a4749
docs(init): document --dry-run in quick-start guide
...
Adds a "Preview without writing" subsection under Step 1 covering the
--dry-run flag, -v interaction for content preview, that telemetry
consent is skipped, and the --show conflict. Required by CONTRIBUTING.md
section 4 (new features need documentation).
2026-04-26 17:53:44 -04:00
4c9b528206
docs: Adrien review — hierarchy, counts, consistency, gaps
...
Hierarchy:
- Move troubleshooting.md and what-rtk-covers.md to guide/resources/
- Add guide/resources/telemetry.md (adapted from docs/TELEMETRY.md,
user-facing: consent, opt-out, GDPR rights — without internal sections)
Content fixes:
- Remove all hardcoded counts (9 ecosystems, 12 agents, 60+, 7 more)
replaced with qualitative language throughout
- Unify DB filename: tracking.db → history.db everywhere
(canonical: src/core/constants.rs HISTORY_DB)
- installation.md: replace bare `cargo install rtk` with warning +
explicit git URL to avoid Rust Type Kit name collision
- supported-agents.md: remove hardcoded agent count
- quick-start.md: remove hardcoded ecosystem list, link to what-rtk-covers
New content:
- gain.md: add --quota section explaining pro/5x/20x tier meanings
- gain.md: add callout linking to discover.md (find missed savings)
- index.md: add "Analyze your usage" section (rtk discover, rtk session)
- configuration.md: clarify ignore_dirs/ignore_files scope, add prose
link to telemetry.md
- what-rtk-covers.md: clarify --ultra-compact vs git -u short flag conflict
Cross-references:
- All internal links updated for new resources/ paths
- index.md: link to troubleshooting, telemetry, what-rtk-covers, analytics
- discover.md: updated relative link to troubleshooting
README:
- Add Core team section (Patrick Szymkowiak, Florian Bruniaux, Adrien Eppling)
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com >
2026-04-14 14:17:58 +02:00
6e55f8984c
docs: address Adrien's review — structure, missing content, agents
...
Structure:
- Move docs/README.md → .github/docs-pipeline-contract.md (interface
contract is not user-facing content)
- Rewrite docs/guide/index.md as a proper landing page with RTK intro,
flow diagram, and navigation (replaces empty nav stub)
- Move configuration.md → getting-started/configuration.md (sidebar order 4,
after supported-agents per Adrien's suggestion)
Missing content:
- Add docs/guide/analytics/discover.md: rtk discover (missed savings analysis)
and rtk session (adoption tracking across sessions)
- Add uninstall instructions to installation.md (rtk init -g --uninstall,
cargo uninstall, brew uninstall)
- Add global flags section to what-rtk-covers.md (-u/--ultra-compact,
-v/--verbose)
- Add rtk smart command to what-rtk-covers.md Files section
Agents:
- Update supported-agents.md: 10 agents (was 9)
- Add OpenClaw (TypeScript plugin, before_tool_call)
- Add Mistral Vibe (planned, issue #800 )
- Fix GitHub Copilot: VS Code = transparent rewrite via PreToolUse,
Copilot CLI = deny-with-suggestion (upstream limitation)
Signed-off-by: Florian BRUNIAUX <florian@bruniaux.com >
2026-04-06 11:16:24 +02:00
25438b29ae
docs(guide): add 11 Phase 1 guide pages — full MVP content
...
Creates the complete user-facing guide for the docs website:
Getting started:
- quick-start.md: 5-minute walkthrough (init, first commands, rtk gain)
- supported-agents.md: Claude Code, Cursor, Copilot, Gemini, Cline, Windsurf,
Codex, OpenCode — integration tiers, install commands, graceful degradation
Commands (adapted from FEATURES.md, English, --help-first format):
- git.md: status/log/diff/show/add/commit/push/pull/branch + gh CLI
- cargo.md: test/nextest/build/check/clippy/install + generic test/err wrappers
- files.md: ls/read/grep/find/diff/wc/smart with before/after examples
- javascript.md: vitest/playwright/tsc/eslint/prettier/next/pnpm/npm/npx/prisma
- python.md: pytest/ruff/mypy/pip/deps
Reference:
- filters/using-filters.md: 8-stage pipeline, lookup priority, TOML DSL reference,
Mermaid diagram (adapted from docs/filter-workflow.md)
- analytics/gain.md: rtk gain flags, daily/weekly/monthly breakdowns, export
formats, token estimation, database management (from docs/AUDIT_GUIDE.md)
- configuration.md: full config.toml reference, env vars, tee system, telemetry
- troubleshooting.md: common issues and fixes (from docs/TROUBLESHOOTING.md)
All pages carry valid frontmatter (title, description, sidebar.order).
No existing files modified.
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com >
Signed-off-by: Florian BRUNIAUX <florian@bruniaux.com >
2026-04-05 00:09:14 +02:00
hed0rah