Skip to content

docs: update README, ARCHITECTURE, SECURITY for v0.44-v0.46#290

Merged
laurentiu021 merged 1 commit into
mainfrom
docs/update-all-docs
May 13, 2026
Merged

docs: update README, ARCHITECTURE, SECURITY for v0.44-v0.46#290
laurentiu021 merged 1 commit into
mainfrom
docs/update-all-docs

Conversation

@laurentiu021

@laurentiu021 laurentiu021 commented May 13, 2026

Copy link
Copy Markdown
Owner

Updates all documentation to reflect features delivered in v0.44.0-v0.46.0.

  • README: tab count 25 implemented / 11 WIP, Windows Features description added
  • ARCHITECTURE: VM table updated, DI section added, new services documented
  • SECURITY: supported versions updated to 0.44.x-0.46.x

Summary by CodeRabbit

  • Documentation
    • Enhanced system documentation with comprehensive information about system structure and overall design.
    • Updated version support matrix: versions 0.46.x, 0.45.x, and 0.44.x are supported; versions 0.43.x and earlier are no longer supported.
    • Updated feature progress: one additional feature tab is now fully implemented and ready for use.

Review Change Stack

- README: update tab count (25 implemented, 11 WIP), add Windows Features description
- ARCHITECTURE: update VM table (WindowsFeatures, AppAlerts, ShortcutCleaner, AppBlocker now real), add ServiceRegistration.cs to layout, add DI section, add WindowsFeaturesService + UninstallerService descriptions
- SECURITY: update supported versions (0.44.x-0.46.x supported, <0.43 unsupported)
@coderabbitai

coderabbitai Bot commented May 13, 2026

Copy link
Copy Markdown
📝 Walkthrough

Walkthrough

This PR updates project documentation to reflect the current system architecture, feature development progress, and version support policy. ARCHITECTURE.md is expanded with solution structure details, service descriptions, and a new Dependency Injection section. README.md feature counts and SECURITY.md version matrix are refreshed.

Changes

Documentation Updates

Layer / File(s) Summary
Architecture documentation: structure, services, and DI
ARCHITECTURE.md
Solution layout is updated to include ServiceRegistration.cs. Tab and app-level view models are documented with PlaceholderViewModel variants. Services section adds WindowsFeaturesService and UninstallerService. New "Dependency Injection" section describes ServiceRegistration.cs configuration, singleton registration, and child VM resolution in MainWindowViewModel.
Feature progress and version support
README.md, SECURITY.md
README.md feature sidebar counts are updated to reflect one additional completed tab and one fewer placeholder. SECURITY.md version matrix is updated to support 0.46.x, 0.45.x, and 0.44.x while marking 0.43.x and earlier as unsupported.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Poem

🐰 Our docs now shine with clarity bright,
Services and structure flow left and right,
Features progress, versions align,
DI patterns documented so fine! ✨

🚥 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 accurately and concisely describes the main change: documentation updates across three key files (README, ARCHITECTURE, SECURITY) for versions 0.44-0.46.
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/update-all-docs

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

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@ARCHITECTURE.md`:
- Around line 121-124: Update the WindowsFeaturesService description to
explicitly list the PowerShell cmdlet used for disabling features: mention
Disable-WindowsOptionalFeature alongside Get-WindowsOptionalFeature and
Enable-WindowsOptionalFeature in the `WindowsFeaturesService` bullet so the
service reads that it lists, enables and disables Windows optional features via
Get-WindowsOptionalFeature / Enable-WindowsOptionalFeature /
Disable-WindowsOptionalFeature.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 0634e16d-b627-45f6-8dac-b0464ceea18a

📥 Commits

Reviewing files that changed from the base of the PR and between 0f28b8c and bfa9f75.

📒 Files selected for processing (3)
  • ARCHITECTURE.md
  • README.md
  • SECURITY.md
📜 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: Analyze (csharp)
  • GitHub Check: Build & unit tests
🔇 Additional comments (3)
SECURITY.md (1)

15-19: LGTM!

ARCHITECTURE.md (1)

24-24: LGTM!

Also applies to: 41-43, 46-46, 72-75, 133-140

README.md (1)

40-41: LGTM!

Comment thread ARCHITECTURE.md
Comment on lines +121 to +124
- `WindowsFeaturesService` — list, enable, disable Windows optional features
via `Get-WindowsOptionalFeature` / `Enable-WindowsOptionalFeature` PowerShell.
- `UninstallerService` — winget-based uninstall + registry UninstallString
fallback for local apps not in winget.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Document the disable command explicitly.

This line says WindowsFeaturesService can disable features, but only lists Get-WindowsOptionalFeature and Enable-WindowsOptionalFeature. Please include Disable-WindowsOptionalFeature to avoid ambiguity.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@ARCHITECTURE.md` around lines 121 - 124, Update the WindowsFeaturesService
description to explicitly list the PowerShell cmdlet used for disabling
features: mention Disable-WindowsOptionalFeature alongside
Get-WindowsOptionalFeature and Enable-WindowsOptionalFeature in the
`WindowsFeaturesService` bullet so the service reads that it lists, enables and
disables Windows optional features via Get-WindowsOptionalFeature /
Enable-WindowsOptionalFeature / Disable-WindowsOptionalFeature.

@codecov-commenter

Copy link
Copy Markdown

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@laurentiu021
laurentiu021 merged commit 47cd971 into main May 13, 2026
5 checks passed
@laurentiu021
laurentiu021 deleted the docs/update-all-docs branch May 13, 2026 08:49
laurentiu021 added a commit that referenced this pull request May 18, 2026
…te call (#301, #300, #299, #298, #295, #290) (#428)

Co-authored-by: laurentiu021 <laurentiu021@users.noreply.github.com>
laurentiu021 added a commit that referenced this pull request May 22, 2026
- README: update tab count (25 implemented, 11 WIP), add Windows Features description
- ARCHITECTURE: update VM table (WindowsFeatures, AppAlerts, ShortcutCleaner, AppBlocker now real), add ServiceRegistration.cs to layout, add DI section, add WindowsFeaturesService + UninstallerService descriptions
- SECURITY: update supported versions (0.44.x-0.46.x supported, <0.43 unsupported)

Co-authored-by: laurentiu021 <laurentiu021@users.noreply.github.com>
laurentiu021 added a commit that referenced this pull request May 22, 2026
…te call (#301, #300, #299, #298, #295, #290) (#428)

Co-authored-by: laurentiu021 <laurentiu021@users.noreply.github.com>
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.

2 participants