Skip to content

docs: add missing feature sections to README#590

Merged
laurentiu021 merged 1 commit into
mainfrom
docs/readme-features
May 28, 2026
Merged

docs: add missing feature sections to README#590
laurentiu021 merged 1 commit into
mainfrom
docs/readme-features

Conversation

@laurentiu021

@laurentiu021 laurentiu021 commented May 28, 2026

Copy link
Copy Markdown
Owner

Summary

  • Add dedicated feature sections for 4 fully-implemented tabs that were missing from the README: Privacy & Telemetry, File Shredder, DNS & Hosts, Bulk Installer
  • Update intro paragraph and "What it is" section to mention all implemented features (context menu, privacy, shredder, DNS, duplicate finder, Windows features)
  • Tab count (30 implemented / 25 WIP / 55 total) and sidebar table remain accurate

Test plan

  • Verify README renders correctly on GitHub
  • Verify all described features match actual app behavior

Summary by CodeRabbit

  • Documentation
    • Expanded feature descriptions covering comprehensive Windows system monitoring and management capabilities.
    • Added detailed documentation for Privacy & Telemetry, File Shredder, DNS & Hosts, and Bulk Installer features, including key sub-features and capabilities.
    • Improved clarity regarding the single tabbed WPF desktop application format.

Review Change Stack

Add dedicated sections for Privacy & Telemetry, File Shredder,
DNS & Hosts, and Bulk Installer. Update intro paragraphs to
mention all implemented features.
@coderabbitai

coderabbitai Bot commented May 28, 2026

Copy link
Copy Markdown

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 365b9a8f-6ee2-4fb2-a71f-804cd3865bc7

📥 Commits

Reviewing files that changed from the base of the PR and between 22ed09a and ad65010.

📒 Files selected for processing (1)
  • README.md
📜 Recent review details
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
  • GitHub Check: Build & unit tests
  • GitHub Check: Analyze (csharp)
🔇 Additional comments (5)
README.md (5)

3-10: LGTM!


28-31: LGTM!


220-228: LGTM!


230-237: LGTM!


239-258: LGTM!


📝 Walkthrough

Walkthrough

README.md content is updated to broaden the project's feature description and presentation. The main tagline and "What it is" section are expanded to enumerate Windows system monitoring/management capabilities, and new feature documentation sections are added for Privacy & Telemetry, File Shredder, DNS & Hosts, and Bulk Installer.

Changes

Documentation Updates

Layer / File(s) Summary
Tagline and overview expansion
README.md
Main README tagline is expanded to enumerate Windows monitoring/management capabilities (Windows Update, disk/memory health, bulk installs, privacy/telemetry controls, context menu management, secure shredding, DNS/hosts editing, battery/process/startup/shortcut controls, app blocking, and Windows features). "What it is" section is reworded to list additional feature categories and clarify single tabbed WPF app delivery.
Feature documentation sections
README.md
New sections document Privacy & Telemetry (registry toggles and reversible settings), File Shredder (multi-pass secure deletion), DNS & Hosts (DNS preset switching and hosts editor with backups), and Bulk Installer (categorized app catalog, custom winget search, and install progress/status tracking).

Possibly related PRs

Poem

🐰 The README now sings a broader tune,
From privacy to shredding, DNS, and winget's boon,
Four new features documented with care,
A single app that does it all—quite rare!
Features enumerated, users will cheer!


🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs: add missing feature sections to README' directly and accurately summarizes the main change—adding documentation for previously undocumented feature sections (Privacy & Telemetry, File Shredder, DNS & Hosts, Bulk Installer) to the README.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/readme-features

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitai

coderabbitai Bot commented May 28, 2026

Copy link
Copy Markdown

Actionable comments posted: 0

@laurentiu021
laurentiu021 merged commit 0779e89 into main May 28, 2026
5 checks passed
@laurentiu021
laurentiu021 deleted the docs/readme-features branch May 28, 2026 12:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant