Skip to content

Commit 97790f7

Browse files
committed
docs: elevate documentation — fix stale refs, add CLI-Reference + TweakCategories
Stale content fixed (6 files): - README.md: version badge 6.18.0→6.24.0, tests badge 3166→3230, section header 'Tweak Categories (26)'→'(122)', test count 3,166→3,230 - Development.md: last-updated date v6.17.0→v6.24.0, test counts updated (2315/379/357 → 2434/434/363) - Api.md: 'Last verified v6.0.0'→v6.24.0, RegisterBuiltins '228 modules'→170 - Troubleshooting.md: '4 themes'→11 themes with full list - Architecture.md: fixed broken HTML (missing <p tag on profiles-quadrant img) - Roadmap.md: baseline updated from v6.13.0 to v6.24.0 (7,429 tweaks / 170 files / 3,230 tests) New documentation (2 files): - docs/CLI-Reference.md: comprehensive command reference — all 40+ commands and subcommands including batch, marketplace, favorites, compliance, profile management, filter flags, export formats (json/reg/gpo/intune/config), environment variables, exit codes, scripting patterns - docs/TweakCategories.md: full category reference — all 122 categories grouped by domain (Privacy, Security, Performance, Shell, Networking, Developer, Accessibility, Peripherals, Multimedia, Services, Office, PM) with slug table, profile×category mapping, and search examples README linked to both new docs.
1 parent a82dd70 commit 97790f7

8 files changed

Lines changed: 971 additions & 16 deletions

File tree

README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!-- SEO / GitHub search keywords
1+
<!-- SEO / GitHub search keywords
22
windows registry tweaks windows 11 debloat privacy hardening performance optimizer
33
disable telemetry windows optimizer system hardening group policy alternative
44
registry editor winforms gui cli dotnet csharp tweak engine
@@ -20,10 +20,10 @@
2020
[![CI](https://github.com/RajwanYair/RegiLattice/actions/workflows/ci.yml/badge.svg)](https://github.com/RajwanYair/RegiLattice/actions/workflows/ci.yml)
2121
![.NET 10](https://img.shields.io/badge/.NET-10.0-512BD4?logo=dotnet&logoColor=white)
2222
![C#](https://img.shields.io/badge/C%23-13-239120?logo=csharp&logoColor=white)
23-
![Tests](https://img.shields.io/badge/tests-3166%20passing-brightgreen)
23+
![Tests](https://img.shields.io/badge/tests-3230%20passing-brightgreen)
2424
![Platform](https://img.shields.io/badge/platform-Windows%20x64-0078D6?logo=windows&logoColor=white)
2525
![License](https://img.shields.io/badge/license-MIT-green)
26-
![Version](https://img.shields.io/badge/version-6.18.0-blue)
26+
![Version](https://img.shields.io/badge/version-6.24.0-blue)
2727

2828
A comprehensive **Windows 10 / Windows 11 registry tweak toolkit** and system optimizer — debloater · privacy hardening tool · performance optimizer · security hardening · group policy alternative — with **7,429 verified tweaks** across **122 categories**, a **declarative RegOp engine**, a **full CLI** with 25+ commands, an **interactive console menu**, and a **WinForms GUI** with **11 switchable themes**. Built on **.NET 10 (C# 13)** for native performance on Windows 10/11 x64.
2929

@@ -67,7 +67,7 @@ Download `RegiLattice.GUI.exe` or `RegiLattice.exe` directly from the [Releases
6767
- **Corporate network safety** — blocks tweaks on domain-joined, Azure AD, VPN, and managed machines
6868
- **Automatic backups** — every registry mutation is backed up to JSON before changes
6969
- **Package managers** — built-in Scoop, pip, Chocolatey, WinGet, and PowerShell module manager dialogs
70-
- **3,166 tests** across 17+ test files — full engine, model, service, plugin, and GUI coverage (xUnit)
70+
- **3,230 tests** across 17+ test files — full engine, model, service, plugin, and GUI coverage (xUnit)
7171
- **Dependency resolution**`ResolveDependencies()` topological sort; `Dependents()` reverse lookup
7272
- **Validation engine**`ValidateTweaks()` checks IDs, labels, categories, broken DependsOn, circular deps
7373
- **Plugin system** — JSON Tweak Packs with marketplace, SHA-256 verification
@@ -80,6 +80,8 @@ Download `RegiLattice.GUI.exe` or `RegiLattice.exe` directly from the [Releases
8080
## Architecture
8181

8282
> Full architecture reference — Mermaid diagrams for data flow, class model, CI pipeline, and more: **[docs/Architecture.md](docs/Architecture.md)**
83+
> CLI commands reference: **[docs/CLI-Reference.md](docs/CLI-Reference.md)**
84+
> Tweak categories reference: **[docs/TweakCategories.md](docs/TweakCategories.md)**
8385
8486
<p align="center">
8587
<img src="docs/assets/architecture.svg" alt="RegiLattice Architecture — Core, GUI, CLI, Tweaks, Registry" width="100%"/>
@@ -108,11 +110,11 @@ Download `RegiLattice.GUI.exe` or `RegiLattice.exe` directly from the [Releases
108110
<img src="docs/assets/themes-preview.svg" alt="11 Switchable Colour Themes" width="100%"/>
109111
</p>
110112

111-
## Tweak Categories (26)
113+
## Tweak Categories (122)
112114

113115
122 categories spanning privacy, performance, security, accessibility, gaming, networking, browser hardening, developer tools, cloud storage, remote desktop, virtualization, and more. Each tweak is fully reversible with apply/remove/detect operations.
114116

115-
See `--show-categories` for the full list with tweak counts, or use `--stats` for a complete breakdown.
117+
See [docs/TweakCategories.md](docs/TweakCategories.md) for the full category reference, or use `--categories` for live counts.
116118

117119
## Requirements
118120

@@ -130,7 +132,7 @@ git clone https://github.com/RajwanYair/RegiLattice.git
130132
cd RegiLattice
131133
dotnet build RegiLattice.sln -c Release
132134
133-
# Run tests (3,166 tests)
135+
# Run tests (3,230 tests)
134136
dotnet test RegiLattice.sln
135137
136138
# Publish self-contained executables

docs/Api.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# API Reference
22

33
> Reference for the RegiLattice C# public API.
4-
> Last verified: 2026-03-31 · v6.0.0
4+
> Last verified: 2026-04-07 · v6.24.0
55
66
---
77

@@ -117,7 +117,7 @@ Central tweak manager. All methods are on the `TweakEngine` class.
117117
| Method | Signature | Description |
118118
|--------|-----------|-------------|
119119
| `Register` | `(TweakDef td)` | Register a single tweak (throws on duplicate ID) |
120-
| `RegisterBuiltins` | `()` | Register all 228 built-in tweak modules |
120+
| `RegisterBuiltins` | `()` | Register all 170 built-in tweak modules (7,429 tweaks) |
121121
| `AllTweaks` | `() -> IReadOnlyList<TweakDef>` | All registered tweaks |
122122
| `GetTweak` | `(string id) -> TweakDef?` | Look up by ID |
123123

docs/Architecture.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Three projects share `RegiLattice.Core` as the single source of truth for tweak
1919
---
2020
<p align="center">
2121
<img src="assets/data-flow.svg" alt="Data Flow — Apply Tweak sequence diagram" width="100%"/>
22-
</p>align="center">
22+
<p align="center">
2323
<img src="assets/profiles-quadrant.svg" alt="Built-in Profiles — quadrant chart" width="100%"/>
2424
</p>
2525

0 commit comments

Comments
 (0)