diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index 413e94f..cf6901c 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -52,7 +52,7 @@ PRs target the **`develop`** branch, not `main`. All commits require a DCO sign- rtk routes CLI commands via a Clap `Commands` enum in `main.rs` to specialized filter modules in `src/cmds/*/`, each executing the underlying command and compressing output. Token savings are tracked in SQLite via `src/core/tracking.rs`. -For full details see [ARCHITECTURE.md](../ARCHITECTURE.md) and [docs/TECHNICAL.md](../docs/TECHNICAL.md). Module responsibilities are documented in each folder's `README.md` and each file's `//!` doc header. +For full details see [ARCHITECTURE.md](../docs/contributing/ARCHITECTURE.md) and [docs/contributing/TECHNICAL.md](../docs/contributing/TECHNICAL.md). Module responsibilities are documented in each folder's `README.md` and each file's `//!` doc header. ## Key Conventions diff --git a/CLAUDE.md b/CLAUDE.md index 0dddf14..9a12b3c 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -70,8 +70,8 @@ cargo generate-rpm # RPM package (needs cargo-generate-rpm, after rel rtk uses a **command proxy architecture**: `main.rs` routes CLI commands via a Clap `Commands` enum to specialized filter modules in `src/cmds/*/`, each of which executes the underlying command and compresses its output. Token savings are tracked in SQLite via `src/core/tracking.rs`. For the full architecture, component details, and module development patterns, see: -- [ARCHITECTURE.md](ARCHITECTURE.md) — System design, module organization, filtering strategies, error handling -- [docs/TECHNICAL.md](docs/TECHNICAL.md) — End-to-end flow, folder map, hook system, filter pipeline +- [ARCHITECTURE.md](docs/contributing/ARCHITECTURE.md) — System design, module organization, filtering strategies, error handling +- [docs/contributing/TECHNICAL.md](docs/contributing/TECHNICAL.md) — End-to-end flow, folder map, hook system, filter pipeline Module responsibilities are documented in each folder's `README.md` and each file's `//!` doc header. Browse `src/cmds/*/` to discover available filters. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 08e5ec0..4ae5bfc 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,7 +7,7 @@ - [Report an Issue](../../issues/new) - [Open Pull Requests](../../pulls) - [Start a Discussion](../../discussions) -- [Technical Documentation](docs/TECHNICAL.md) — Architecture, end-to-end flow, folder map, how to write tests +- [Technical Documentation](docs/contributing/TECHNICAL.md) — Architecture, end-to-end flow, folder map, how to write tests --- @@ -203,7 +203,7 @@ your branch --> develop (review + CI + integration testing) --> version branch - Every change **must** include tests. We follow **TDD (Red-Green-Refactor)**: write a failing test first, implement the minimum to pass, then refactor. -For how to write tests (fixtures, snapshots, token savings verification), see [docs/TECHNICAL.md — Testing](docs/TECHNICAL.md#testing). +For how to write tests (fixtures, snapshots, token savings verification), see [docs/contributing/TECHNICAL.md — Testing](docs/contributing/TECHNICAL.md#testing). ### Test Types @@ -242,12 +242,12 @@ Every change **must** include documentation updates. Use this table to find whic | New Rust filter (`src/cmds/`) | Ecosystem `README.md` (e.g., `src/cmds/git/README.md`), [README.md](README.md) command list, [CHANGELOG.md](CHANGELOG.md) | | New TOML filter (`src/filters/`) | [src/filters/README.md](src/filters/README.md) if naming conventions change, [README.md](README.md) command list, [CHANGELOG.md](CHANGELOG.md) | | New rewrite pattern | `src/discover/rules.rs` — see [Adding a New Command Filter](src/cmds/README.md#adding-a-new-command-filter) | -| Core infrastructure (`src/core/`) | [src/core/README.md](src/core/README.md), [docs/TECHNICAL.md](docs/TECHNICAL.md) if flow changes | +| Core infrastructure (`src/core/`) | [src/core/README.md](src/core/README.md), [docs/contributing/TECHNICAL.md](docs/contributing/TECHNICAL.md) if flow changes | | Hook system (`src/hooks/`) | [src/hooks/README.md](src/hooks/README.md), [hooks/README.md](hooks/README.md) for agent-facing docs | -| Architecture or design change | [ARCHITECTURE.md](ARCHITECTURE.md), [docs/TECHNICAL.md](docs/TECHNICAL.md) | +| Architecture or design change | [ARCHITECTURE.md](docs/contributing/ARCHITECTURE.md), [docs/contributing/TECHNICAL.md](docs/contributing/TECHNICAL.md) | | Bug fix or breaking change | [CHANGELOG.md](CHANGELOG.md) | -**Navigation**: [CONTRIBUTING.md](CONTRIBUTING.md) (you are here) → [docs/TECHNICAL.md](docs/TECHNICAL.md) (architecture + flow) → each folder's `README.md` (implementation details). +**Navigation**: [CONTRIBUTING.md](CONTRIBUTING.md) (you are here) → [docs/contributing/TECHNICAL.md](docs/contributing/TECHNICAL.md) (architecture + flow) → each folder's `README.md` (implementation details). Keep documentation concise and practical -- examples over explanations. diff --git a/DISCLAIMER.md b/DISCLAIMER.md new file mode 100644 index 0000000..3983777 --- /dev/null +++ b/DISCLAIMER.md @@ -0,0 +1,29 @@ +# Disclaimer + +## No Warranty + +This software is provided "AS IS", without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose, and non-infringement. The entire risk as to the quality and performance of the software is with you. + +## Limitation of Liability + +In no event shall the authors or copyright holders be liable for any claim, damages, or other liability, whether in an action of contract, tort, or otherwise, arising from, out of, or in connection with the software or the use or other dealings in the software. This includes, without limitation, any direct, indirect, incidental, special, exemplary, or consequential damages (including but not limited to loss of data, loss of profits, or business interruption). + +## Precompiled Binaries + +Precompiled binaries are provided solely for convenience and are covered by the same license as the source code (Apache License 2.0). They are provided without warranties or conditions of any kind. You are responsible for verifying the integrity and suitability of any binary before use. Always verify checksums when available. + +## Third-Party Dependencies + +This software incorporates third-party open-source components, each governed by their respective licenses. The authors make no representations or warranties regarding these dependencies and accept no liability for any issues arising from their use. + +## Use at Your Own Risk + +This software interacts with your development environment, file system, and external commands. It is your responsibility to ensure that its use is appropriate for your environment and complies with any applicable policies, regulations, or agreements. The authors are not responsible for any unintended side effects resulting from its use. + +## Telemetry + +This software collects anonymous, aggregate usage metrics by default and can be disabled at any time. No personally identifiable information, source code, file paths, command arguments, or secrets are collected. See the README for full details and opt-out instructions. + +--- + +See [LICENSE](LICENSE) for the full terms of the Apache License 2.0 under which this software is distributed. diff --git a/README.md b/README.md index 05f77de..8dfdf94 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ Website • Install • Troubleshooting • - Architecture • + Architecture • Discord

@@ -466,7 +466,7 @@ brew uninstall rtk # If installed via Homebrew - **[TROUBLESHOOTING.md](docs/TROUBLESHOOTING.md)** - Fix common issues - **[INSTALL.md](INSTALL.md)** - Detailed installation guide -- **[ARCHITECTURE.md](ARCHITECTURE.md)** - Technical architecture +- **[ARCHITECTURE.md](docs/contributing/ARCHITECTURE.md)** - Technical architecture - **[SECURITY.md](SECURITY.md)** - Security policy and PR review process - **[AUDIT_GUIDE.md](docs/AUDIT_GUIDE.md)** - Token savings analytics guide @@ -501,3 +501,7 @@ Join the community on [Discord](https://discord.gg/RySmvNF5kF). ## License MIT License - see [LICENSE](LICENSE) for details. + +## Disclaimer + +See [DISCLAIMER.md](DISCLAIMER.md). diff --git a/README_es.md b/README_es.md index c099d66..27237ac 100644 --- a/README_es.md +++ b/README_es.md @@ -18,7 +18,7 @@ Sitio web • Instalar • Solucion de problemas • - Arquitectura • + Arquitectura • Discord

@@ -146,7 +146,7 @@ rtk discover # Descubrir ahorros perdidos - **[TROUBLESHOOTING.md](docs/TROUBLESHOOTING.md)** - Resolver problemas comunes - **[INSTALL.md](INSTALL.md)** - Guia de instalacion detallada -- **[ARCHITECTURE.md](ARCHITECTURE.md)** - Arquitectura tecnica +- **[ARCHITECTURE.md](docs/contributing/ARCHITECTURE.md)** - Arquitectura tecnica ## Contribuir @@ -157,3 +157,7 @@ Unete a la comunidad en [Discord](https://discord.gg/RySmvNF5kF). ## Licencia Licencia MIT - ver [LICENSE](LICENSE) para detalles. + +## Descargo de responsabilidad + +Ver [DISCLAIMER.md](DISCLAIMER.md). diff --git a/README_fr.md b/README_fr.md index 4c5e749..a29f52e 100644 --- a/README_fr.md +++ b/README_fr.md @@ -18,7 +18,7 @@ Site web • Installer • Depannage • - Architecture • + Architecture • Discord

@@ -184,7 +184,7 @@ mode = "failures" - **[TROUBLESHOOTING.md](docs/TROUBLESHOOTING.md)** - Resoudre les problemes courants - **[INSTALL.md](INSTALL.md)** - Guide d'installation detaille -- **[ARCHITECTURE.md](ARCHITECTURE.md)** - Architecture technique +- **[ARCHITECTURE.md](docs/contributing/ARCHITECTURE.md)** - Architecture technique ## Contribuer @@ -195,3 +195,7 @@ Rejoignez la communaute sur [Discord](https://discord.gg/RySmvNF5kF). ## Licence Licence MIT - voir [LICENSE](LICENSE) pour les details. + +## Avertissement + +Voir [DISCLAIMER.md](DISCLAIMER.md). diff --git a/README_ja.md b/README_ja.md index 6c690af..e0db098 100644 --- a/README_ja.md +++ b/README_ja.md @@ -18,7 +18,7 @@ ウェブサイト • インストール • トラブルシューティング • - アーキテクチャ • + アーキテクチャ • Discord

@@ -146,7 +146,7 @@ rtk discover # 見逃した節約機会を発見 - **[TROUBLESHOOTING.md](docs/TROUBLESHOOTING.md)** - よくある問題の解決 - **[INSTALL.md](INSTALL.md)** - 詳細インストールガイド -- **[ARCHITECTURE.md](ARCHITECTURE.md)** - 技術アーキテクチャ +- **[ARCHITECTURE.md](docs/contributing/ARCHITECTURE.md)** - 技術アーキテクチャ ## コントリビュート @@ -157,3 +157,7 @@ rtk discover # 見逃した節約機会を発見 ## ライセンス MIT ライセンス - 詳細は [LICENSE](LICENSE) を参照。 + +## 免責事項 + +詳細は [DISCLAIMER.md](DISCLAIMER.md) を参照。 diff --git a/README_ko.md b/README_ko.md index 5d3b1a0..abc35a1 100644 --- a/README_ko.md +++ b/README_ko.md @@ -18,7 +18,7 @@ 웹사이트 • 설치 • 문제 해결 • - 아키텍처 • + 아키텍처 • Discord

@@ -146,7 +146,7 @@ rtk discover # 놓친 절약 기회 발견 - **[TROUBLESHOOTING.md](docs/TROUBLESHOOTING.md)** - 일반적인 문제 해결 - **[INSTALL.md](INSTALL.md)** - 상세 설치 가이드 -- **[ARCHITECTURE.md](ARCHITECTURE.md)** - 기술 아키텍처 +- **[ARCHITECTURE.md](docs/contributing/ARCHITECTURE.md)** - 기술 아키텍처 ## 기여 @@ -157,3 +157,7 @@ rtk discover # 놓친 절약 기회 발견 ## 라이선스 MIT 라이선스 - 자세한 내용은 [LICENSE](LICENSE)를 참조하세요. + +## 면책 조항 + +자세한 내용은 [DISCLAIMER.md](DISCLAIMER.md)를 참조하세요. diff --git a/README_zh.md b/README_zh.md index 00b9c00..c4a358d 100644 --- a/README_zh.md +++ b/README_zh.md @@ -18,7 +18,7 @@ 官网 • 安装 • 故障排除 • - 架构 • + 架构 • Discord

@@ -154,7 +154,7 @@ rtk discover # 发现遗漏的节省机会 - **[TROUBLESHOOTING.md](docs/TROUBLESHOOTING.md)** - 解决常见问题 - **[INSTALL.md](INSTALL.md)** - 详细安装指南 -- **[ARCHITECTURE.md](ARCHITECTURE.md)** - 技术架构 +- **[ARCHITECTURE.md](docs/contributing/ARCHITECTURE.md)** - 技术架构 ## 贡献 @@ -165,3 +165,7 @@ rtk discover # 发现遗漏的节省机会 ## 许可证 MIT 许可证 - 详见 [LICENSE](LICENSE)。 + +## 免责声明 + +详见 [DISCLAIMER.md](DISCLAIMER.md)。 diff --git a/ROADMAP.md b/ROADMAP.md deleted file mode 100644 index 7f8e1d6..0000000 --- a/ROADMAP.md +++ /dev/null @@ -1,15 +0,0 @@ -# RTK Roadmap - - -Stability & Reliability - - Critical Fixes: Resolve bugs and stabilize Vitest/pnpm support. - - Fork Strategy: Establish the fork as the new standard if upstream remains inactive. - - Pro Tooling: Add a configuration file (TOML) and structured logging. - - Easy Install: Launch a Homebrew formula and pre-compiled binaries for one-click setup. - - Early Adoption: Prove token savings on real projects to onboard the first 5 teams. - ---- diff --git a/ARCHITECTURE.md b/docs/contributing/ARCHITECTURE.md similarity index 98% rename from ARCHITECTURE.md rename to docs/contributing/ARCHITECTURE.md index a803dcb..72d2887 100644 --- a/ARCHITECTURE.md +++ b/docs/contributing/ARCHITECTURE.md @@ -1,6 +1,6 @@ # rtk Architecture Documentation -> **Deep reference** for RTK's system design, filtering taxonomy, performance characteristics, and architecture decisions. For a guided tour of the end-to-end flow, start with [docs/TECHNICAL.md](docs/TECHNICAL.md). +> **Deep reference** for RTK's system design, filtering taxonomy, performance characteristics, and architecture decisions. For a guided tour of the end-to-end flow, start with [TECHNICAL.md](TECHNICAL.md). **rtk (Rust Token Killer)** is a high-performance CLI proxy that minimizes LLM token consumption through intelligent output filtering and compression. @@ -26,7 +26,7 @@ ## System Overview -> For the proxy pattern diagram and key components table, see [docs/TECHNICAL.md](docs/TECHNICAL.md#2-architecture-overview). +> For the proxy pattern diagram and key components table, see [TECHNICAL.md](TECHNICAL.md#2-architecture-overview). ### Design Principles @@ -38,7 +38,7 @@ ### Hook Architecture (v0.9.5+) -> For the hook interception diagram and agent-specific JSON formats, see [docs/TECHNICAL.md](docs/TECHNICAL.md#32-hook-interception-command-rewriting) and [hooks/README.md](hooks/README.md). +> For the hook interception diagram and agent-specific JSON formats, see [TECHNICAL.md](TECHNICAL.md#32-hook-interception-command-rewriting) and [hooks/README.md](hooks/README.md). Two hook strategies: @@ -159,7 +159,7 @@ Database: ~/.local/share/rtk/history.db ### Module Map -> For the full file-level module tree, see [docs/TECHNICAL.md](docs/TECHNICAL.md#4-folder-map) and each folder's README. +> For the full file-level module tree, see [TECHNICAL.md](TECHNICAL.md#4-folder-map) and each folder's README. **Token savings by ecosystem:** @@ -1034,7 +1034,7 @@ Overhead Sources: ## Resources -- **[docs/TECHNICAL.md](docs/TECHNICAL.md)**: Guided tour of end-to-end flow +- **[TECHNICAL.md](TECHNICAL.md)**: Guided tour of end-to-end flow - **[CONTRIBUTING.md](CONTRIBUTING.md)**: Design philosophy, contribution workflow, checklist - **CLAUDE.md**: Quick reference for AI agents (dev commands, build verification) - **README.md**: User guide, installation, examples diff --git a/docs/TECHNICAL.md b/docs/contributing/TECHNICAL.md similarity index 99% rename from docs/TECHNICAL.md rename to docs/contributing/TECHNICAL.md index 0452268..ddadf8d 100644 --- a/docs/TECHNICAL.md +++ b/docs/contributing/TECHNICAL.md @@ -3,7 +3,7 @@ > **Start here** for a guided tour of how RTK works end-to-end. > > - [CONTRIBUTING.md](../CONTRIBUTING.md) — Design philosophy, PR process, branch naming, testing requirements -> - [ARCHITECTURE.md](../ARCHITECTURE.md) — Deep reference: filtering taxonomy, performance benchmarks, architecture decisions +> - [ARCHITECTURE.md](ARCHITECTURE.md) — Deep reference: filtering taxonomy, performance benchmarks, architecture decisions > - Each folder has its own `README.md` with implementation details and file descriptions --- diff --git a/docs/filter-workflow.md b/docs/filter-workflow.md deleted file mode 100644 index 0b0d32c..0000000 --- a/docs/filter-workflow.md +++ /dev/null @@ -1,102 +0,0 @@ -# How a TOML filter goes from file to execution - -This document explains what happens between "I created `src/filters/my-tool.toml`" and "RTK filters the output of `my-tool`". - -## Build pipeline - -```mermaid -flowchart TD - A[["📄 src/filters/my-tool.toml\n(new file)"]] --> B - - subgraph BUILD ["🔨 cargo build"] - B["build.rs\n① ls src/filters/*.toml\n② sort alphabetically\n③ concat → schema_version = 1 + all files"] --> C - C{"TOML valid?\nDuplicate names?"} -->|"❌ panic! (build fails)"| D[["🛑 Error message\npoints to bad file"]] - C -->|"✅ ok"| E[["OUT_DIR/builtin_filters.toml\n(generated file)"]] - E --> F["rustc\ninclude_str!(concat!(env!(OUT_DIR),\n'/builtin_filters.toml'))"] - F --> G[["🦀 rtk binary\nBUILTIN_TOML embedded"]] - end - - subgraph TESTS ["🧪 cargo test"] - H["test_builtin_filter_count\nassert_eq!(filters.len(), N)"] -->|"❌ count wrong"| I[["FAIL\n'Expected N, got N+1'\nUpdate the count'"]] - J["test_builtin_all_expected_\nfilters_present\nassert!(names.contains('my-tool'))"] -->|"❌ name missing"| K[["FAIL\n'my-tool is missing—\nwas its .toml deleted?'"]] - L["test_builtin_all_filters_\nhave_inline_tests\nassert!(tested.contains(name))"] -->|"❌ no tests"| M[["FAIL\n'Add tests.my-tool\nentries'"]] - end - - subgraph VERIFY ["✅ rtk verify"] - N["runs [[tests.my-tool]]\ninput → filter → compare expected"] - N -->|"❌ mismatch"| O[["FAIL\nshows actual vs expected"]] - N -->|"✅ pass"| P[["60/60 tests passed"]] - end - - G --> H - G --> J - G --> L - G --> N - - subgraph RUNTIME ["⚡ rtk my-tool --verbose"] - Q["Claude Code hook\nmy-tool ... → rtk my-tool ..."] --> R - R["TomlFilterRegistry::load()\n① .rtk/filters.toml (project)\n② ~/.config/rtk/filters.toml (user)\n③ BUILTIN_TOML (binary)\n④ passthrough"] --> S - S{"match_command\n'^my-tool\\b'\nmatches?"} -->|"No match"| T[["exec raw\n(passthrough)"]] - S -->|"✅ match"| U["exec command\ncapture stdout"] - U --> V - - subgraph PIPELINE ["8-stage filter pipeline"] - V["strip_ansi"] --> W["replace"] - W --> X{"match_output\nshort-circuit?"} - X -->|"✅ pattern matched"| Y[["emit message\nstop pipeline"]] - X -->|"no match"| Z["strip/keep_lines"] - Z --> AA["truncate_lines_at"] - AA --> AB["tail_lines"] - AB --> AC["max_lines"] - AC --> AD{"output\nempty?"} - AD -->|"yes"| AE[["emit on_empty"]] - AD -->|"no"| AF[["print filtered\noutput + exit code"]] - end - end - - G --> Q - - style BUILD fill:#1e3a5f,color:#fff - style TESTS fill:#1a3a1a,color:#fff - style VERIFY fill:#2d1b69,color:#fff - style RUNTIME fill:#3a1a1a,color:#fff - style PIPELINE fill:#4a2a00,color:#fff - style D fill:#8b0000,color:#fff - style I fill:#8b0000,color:#fff - style K fill:#8b0000,color:#fff - style M fill:#8b0000,color:#fff - style O fill:#8b0000,color:#fff -``` - -## Step-by-step summary - -| Step | Who | What happens | Fails if | -|------|-----|--------------|----------| -| 1 | Contributor | Creates `src/filters/my-tool.toml` | — | -| 2 | `build.rs` | Concatenates all `.toml` files alphabetically | TOML syntax error, duplicate filter name | -| 3 | `rustc` | Embeds result in binary via `BUILTIN_TOML` const | — | -| 4 | `cargo test` | 3 guards check count, names, inline test presence | Count not updated, name not in list, no `[[tests.*]]` | -| 5 | `rtk verify` | Runs each `[[tests.my-tool]]` entry | Filter logic doesn't match expected output | -| 6 | Runtime | Hook rewrites command, registry looks up filter, pipeline runs | No match → passthrough (not an error) | - -## Filter lookup priority at runtime - -```mermaid -flowchart LR - CMD["rtk my-tool args"] --> P1 - P1{"1. .rtk/filters.toml\n(project-local)"} - P1 -->|"✅ match"| WIN["apply filter"] - P1 -->|"no match"| P2 - P2{"2. ~/.config/rtk/filters.toml\n(user-global)\n(macOS alt: ~/Library/Application Support/rtk/filters.toml)"} - P2 -->|"✅ match"| WIN - P2 -->|"no match"| P3 - P3{"3. BUILTIN_TOML\n(binary)"} - P3 -->|"✅ match"| WIN - P3 -->|"no match"| P4[["exec raw\n(passthrough)"]] -``` - -First match wins. A project filter with the same name as a built-in shadows the built-in and triggers a warning: - -``` -[rtk] warning: filter 'make' is shadowing a built-in filter -``` diff --git a/docs/images/gain-dashboard.jpg b/docs/images/gain-dashboard.jpg deleted file mode 100644 index 0d57d7b..0000000 Binary files a/docs/images/gain-dashboard.jpg and /dev/null differ diff --git a/docs/AUDIT_GUIDE.md b/docs/usage/AUDIT_GUIDE.md similarity index 99% rename from docs/AUDIT_GUIDE.md rename to docs/usage/AUDIT_GUIDE.md index 8bcebdf..4ce6fec 100644 --- a/docs/AUDIT_GUIDE.md +++ b/docs/usage/AUDIT_GUIDE.md @@ -429,4 +429,4 @@ print(f'rtk estimate: {len(text) // 4}') - [README.md](../README.md) - Full rtk documentation - [CLAUDE.md](../CLAUDE.md) - Claude Code integration guide -- [ARCHITECTURE.md](../ARCHITECTURE.md) - Technical architecture +- [ARCHITECTURE.md](../contributing/ARCHITECTURE.md) - Technical architecture diff --git a/docs/FEATURES.md b/docs/usage/FEATURES.md similarity index 100% rename from docs/FEATURES.md rename to docs/usage/FEATURES.md diff --git a/docs/tracking.md b/docs/usage/TRACKING.md similarity index 100% rename from docs/tracking.md rename to docs/usage/TRACKING.md diff --git a/src/analytics/README.md b/src/analytics/README.md index b6c6517..5cea9ce 100644 --- a/src/analytics/README.md +++ b/src/analytics/README.md @@ -1,6 +1,6 @@ # Analytics -> See also [docs/TECHNICAL.md](../../docs/TECHNICAL.md) for the full architecture overview +> See also [docs/contributing/TECHNICAL.md](../../docs/contributing/TECHNICAL.md) for the full architecture overview ## Scope diff --git a/src/cmds/cloud/README.md b/src/cmds/cloud/README.md index 7bfa922..893a3be 100644 --- a/src/cmds/cloud/README.md +++ b/src/cmds/cloud/README.md @@ -1,6 +1,6 @@ # Cloud and Infrastructure -> Part of [`src/cmds/`](../README.md) — see also [docs/TECHNICAL.md](../../../docs/TECHNICAL.md) +> Part of [`src/cmds/`](../README.md) — see also [docs/contributing/TECHNICAL.md](../../../docs/contributing/TECHNICAL.md) ## Specifics diff --git a/src/cmds/dotnet/README.md b/src/cmds/dotnet/README.md index 707aaab..dc6b0cf 100644 --- a/src/cmds/dotnet/README.md +++ b/src/cmds/dotnet/README.md @@ -1,6 +1,6 @@ # .NET Ecosystem -> Part of [`src/cmds/`](../README.md) — see also [docs/TECHNICAL.md](../../../docs/TECHNICAL.md) +> Part of [`src/cmds/`](../README.md) — see also [docs/contributing/TECHNICAL.md](../../../docs/contributing/TECHNICAL.md) ## Specifics diff --git a/src/cmds/git/README.md b/src/cmds/git/README.md index ec595ca..d6d867c 100644 --- a/src/cmds/git/README.md +++ b/src/cmds/git/README.md @@ -1,6 +1,6 @@ # Git and VCS -> Part of [`src/cmds/`](../README.md) — see also [docs/TECHNICAL.md](../../../docs/TECHNICAL.md) +> Part of [`src/cmds/`](../README.md) — see also [docs/contributing/TECHNICAL.md](../../../docs/contributing/TECHNICAL.md) ## Specifics diff --git a/src/cmds/go/README.md b/src/cmds/go/README.md index 3f42ee9..47db60f 100644 --- a/src/cmds/go/README.md +++ b/src/cmds/go/README.md @@ -1,6 +1,6 @@ # Go Ecosystem -> Part of [`src/cmds/`](../README.md) — see also [docs/TECHNICAL.md](../../../docs/TECHNICAL.md) +> Part of [`src/cmds/`](../README.md) — see also [docs/contributing/TECHNICAL.md](../../../docs/contributing/TECHNICAL.md) ## Specifics diff --git a/src/cmds/js/README.md b/src/cmds/js/README.md index 49dfebc..24bed8b 100644 --- a/src/cmds/js/README.md +++ b/src/cmds/js/README.md @@ -1,6 +1,6 @@ # JavaScript / TypeScript / Node -> Part of [`src/cmds/`](../README.md) — see also [docs/TECHNICAL.md](../../../docs/TECHNICAL.md) +> Part of [`src/cmds/`](../README.md) — see also [docs/contributing/TECHNICAL.md](../../../docs/contributing/TECHNICAL.md) ## Specifics diff --git a/src/cmds/python/README.md b/src/cmds/python/README.md index 5f40ac7..7295ded 100644 --- a/src/cmds/python/README.md +++ b/src/cmds/python/README.md @@ -1,6 +1,6 @@ # Python Ecosystem -> Part of [`src/cmds/`](../README.md) — see also [docs/TECHNICAL.md](../../../docs/TECHNICAL.md) +> Part of [`src/cmds/`](../README.md) — see also [docs/contributing/TECHNICAL.md](../../../docs/contributing/TECHNICAL.md) ## Specifics diff --git a/src/cmds/ruby/README.md b/src/cmds/ruby/README.md index 08abbc0..c26f263 100644 --- a/src/cmds/ruby/README.md +++ b/src/cmds/ruby/README.md @@ -1,6 +1,6 @@ # Ruby on Rails -> Part of [`src/cmds/`](../README.md) — see also [docs/TECHNICAL.md](../../../docs/TECHNICAL.md) +> Part of [`src/cmds/`](../README.md) — see also [docs/contributing/TECHNICAL.md](../../../docs/contributing/TECHNICAL.md) ## Specifics diff --git a/src/cmds/rust/README.md b/src/cmds/rust/README.md index f7f9204..fd78777 100644 --- a/src/cmds/rust/README.md +++ b/src/cmds/rust/README.md @@ -1,6 +1,6 @@ # Rust Ecosystem -> Part of [`src/cmds/`](../README.md) — see also [docs/TECHNICAL.md](../../../docs/TECHNICAL.md) +> Part of [`src/cmds/`](../README.md) — see also [docs/contributing/TECHNICAL.md](../../../docs/contributing/TECHNICAL.md) ## Specifics diff --git a/src/cmds/system/README.md b/src/cmds/system/README.md index ec3b327..1fdf139 100644 --- a/src/cmds/system/README.md +++ b/src/cmds/system/README.md @@ -1,6 +1,6 @@ # System and Generic Utilities -> Part of [`src/cmds/`](../README.md) — see also [docs/TECHNICAL.md](../../../docs/TECHNICAL.md) +> Part of [`src/cmds/`](../README.md) — see also [docs/contributing/TECHNICAL.md](../../../docs/contributing/TECHNICAL.md) ## Specifics diff --git a/src/core/README.md b/src/core/README.md index 59e70bb..9c58529 100644 --- a/src/core/README.md +++ b/src/core/README.md @@ -1,6 +1,6 @@ # Core Infrastructure -> See also [docs/TECHNICAL.md](../../docs/TECHNICAL.md) for the full architecture overview +> See also [docs/contributing/TECHNICAL.md](../../docs/contributing/TECHNICAL.md) for the full architecture overview ## Scope diff --git a/src/discover/README.md b/src/discover/README.md index 02f6aaa..4897fe8 100644 --- a/src/discover/README.md +++ b/src/discover/README.md @@ -1,6 +1,6 @@ # Discover — History Analysis & Command Rewrite -> Full rewrite pipeline diagram: [docs/TECHNICAL.md](../../docs/TECHNICAL.md#32-hook-interception-command-rewriting) +> Full rewrite pipeline diagram: [docs/contributing/TECHNICAL.md](../../docs/contributing/TECHNICAL.md#32-hook-interception-command-rewriting) ## What This Module Does diff --git a/src/filters/README.md b/src/filters/README.md index 1fabae7..fbd4c4c 100644 --- a/src/filters/README.md +++ b/src/filters/README.md @@ -1,6 +1,6 @@ # Built-in Filters -> See also [docs/TECHNICAL.md](../../docs/TECHNICAL.md) for the full architecture overview +> See also [docs/contributing/TECHNICAL.md](../../docs/contributing/TECHNICAL.md) for the full architecture overview Each `.toml` file in this directory defines one filter and its inline tests. Files are concatenated alphabetically by `build.rs` into a single TOML blob embedded in the binary. diff --git a/src/hooks/README.md b/src/hooks/README.md index 216f495..4f1028a 100644 --- a/src/hooks/README.md +++ b/src/hooks/README.md @@ -1,6 +1,6 @@ # Hook System -> See also [docs/TECHNICAL.md](../../docs/TECHNICAL.md) for the full architecture overview | [hooks/](../../hooks/README.md) for deployed hook artifacts +> See also [docs/contributing/TECHNICAL.md](../../docs/contributing/TECHNICAL.md) for the full architecture overview | [hooks/](../../hooks/README.md) for deployed hook artifacts ## Scope diff --git a/src/learn/README.md b/src/learn/README.md index 5a277f2..233dc4d 100644 --- a/src/learn/README.md +++ b/src/learn/README.md @@ -1,6 +1,6 @@ # Learn — CLI Correction Detection -> See also [docs/TECHNICAL.md](../../docs/TECHNICAL.md) for the full architecture overview +> See also [docs/contributing/TECHNICAL.md](../../docs/contributing/TECHNICAL.md) for the full architecture overview ## Purpose diff --git a/src/parser/README.md b/src/parser/README.md index af5664c..a0ae36f 100644 --- a/src/parser/README.md +++ b/src/parser/README.md @@ -1,6 +1,6 @@ # Parser Infrastructure -> See also [docs/TECHNICAL.md](../../docs/TECHNICAL.md) for the full architecture overview +> See also [docs/contributing/TECHNICAL.md](../../docs/contributing/TECHNICAL.md) for the full architecture overview ## Overview