Skip to content

docs(readme): sync Features section with shipped state#525

Merged
rainxchzed merged 1 commit intomainfrom
chore/readme-feature-sync
May 6, 2026
Merged

docs(readme): sync Features section with shipped state#525
rainxchzed merged 1 commit intomainfrom
chore/readme-feature-sync

Conversation

@rainxchzed
Copy link
Copy Markdown
Member

@rainxchzed rainxchzed commented May 6, 2026

README's Features section had drifted from the actual shipped state. This PR audits + re-syncs it.

Removed (stale)

Added (shipped, previously unadvertised)

Smart discovery

Rich details screen

  • License sourced from backend (no GitHub quota cost) β€” was only mentioned for stars/forks/issues; license + open-issues now share the "anonymous + signed-in get the same data" story.
  • Manual refresh affordance (pull-to-refresh on Android, overflow Refresh on every platform, Ctrl/Cmd+R on desktop).
  • Per-app variant pinning + asset filter regex.

App management

  • Obtainium import/export.
  • Dhizuku silent install (Android, Magisk-free Device Owner).
  • Signing fingerprint verification for auto-updates.
  • Auto-update line now mentions Dhizuku alongside Shizuku/Sui.

Tweaks

  • Installation: Dhizuku option + Installer attribution sub-setting.
  • Translation provider picker (Google + Youdao).

Network & performance

What stayed

Sections, ordering, tone, badges. No restructure β€” additive only.

Out of scope

  • FAQ section. Still accurate.
  • OAuth setup guide. Still accurate.
  • Wiki / website / discord links. Still accurate.

Summary by CodeRabbit

  • Documentation
    • Updated README with comprehensive feature documentation including enhanced smart discovery (Recently Updated/Released sorts, search history, clipboard detection), rich details screen (metadata, release notes, installers), improved app management (silent install, fingerprint verification, background updates), UI refinements, and OS root certificate support.

…glass, add Dhizuku, Obtainium I/O, Add from starred, manual refresh, Recently Released sort, installer attribution, translation provider, OS root cert trust, signing fingerprint, variant pinning, license-from-backend
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 6, 2026

Walkthrough

README.md is updated with expanded feature documentation across Smart discovery, Rich details, App management, Tweaks, and Network sections. New capabilities documented include advanced search filtering, metadata rendering, Dhizuku silent installation, signing verification, background auto-updates, and desktop OS root certificate support for TLS interception proxies.

Changes

Documentation Updates

Layer / File(s) Summary
Smart Discovery
README.md (lines 131–138)
Search sorting now includes Recently Updated and Recently Released; Search history, Clipboard link detection, Hide seen repos, and Add from starred features are documented.
Rich Details Screen
README.md (lines 156–166)
Metadata (Stars, Forks, Open Issues, License), README rendering, release notes, installers list, pre-release chip, merged changes, per-app variant pinning, and asset filter regex are added to details screen documentation.
App Management
README.md (lines 175–178)
Dhizuku silent installation, signing fingerprint verification for auto-updates, background update checks, and auto-update capability features are documented.
Tweaks & Network
README.md (lines 196–211)
Appearance section removes liquid glass UI effect reference; new Network subsection added; Installation now includes Installer attribution sub-setting; Translation provider options documented; Desktop OS-installed root certificates support added for TLS interception proxy handling.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

  • OpenHub-Store/GitHub-Store#500: Overlapping README.md updates to Smart discovery, Rich details, App management, and Tweaks sections with same feature documentation theme.
  • OpenHub-Store/GitHub-Store#364: Shared feature additions (expanded discovery/search, app management enhancements, Tweaks updates) documented in README.
  • OpenHub-Store/GitHub-Store#282: Related README.md modifications covering Smart discovery, Rich details, App management, and Network/installation documentation.

Poem

🐰 A rabbit hops through README's halls,
Each line now clearβ€”no proxy walls!
With certificates and search so bright,
Discovery flows, TLS takes flight! ✨

πŸš₯ 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 PR title 'docs(readme): sync Features section with shipped state' accurately describes the main objective: auditing and resynchronizing the README's Features section with the actual shipped functionality.
Linked Issues check βœ… Passed The PR addresses issue #460 by adding OS root certificate store support for Desktop, which handles TLS interception from tools like Watt Toolkit. However, the README changes primarily document shipped features rather than implementing the fix itself.
Out of Scope Changes check βœ… Passed The PR scope is limited to documentation updates of the README's Features and Tweaks sections to reflect shipped functionality. No code changes are included, and out-of-scope items (FAQ, OAuth guide, external links) are explicitly excluded.
Docstring Coverage βœ… Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ 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 chore/readme-feature-sync

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.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
README.md (1)

276-276: ⚠️ Potential issue | 🟑 Minor | ⚑ Quick win

Remove the stale "liquid glass effects" reference.

The liquid glass UI effect was removed in #518 and correctly omitted from the updated Tweaks section (line 196), but this FAQ entry still mentions it. Users reading the FAQ may expect a feature that no longer exists.

πŸ“ Proposed fix
-- **Fully customizable**
-  Theme colors, AMOLED mode, fonts, liquid glass effects, proxy settings, and more β€” all in one Tweaks screen.
+- **Fully customizable**
+  Theme colors, AMOLED mode, fonts, proxy settings, and more β€” all in one Tweaks screen.
πŸ€– 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 `@README.md` at line 276, Remove the stale "liquid glass effects" mention from
the FAQ sentence that currently reads "Theme colors, AMOLED mode, fonts, liquid
glass effects, proxy settings, and more β€” all in one Tweaks screen." in the
README; edit the sentence in the Tweaks FAQ entry to omit "liquid glass effects"
and adjust punctuation so it reads naturally (e.g., "Theme colors, AMOLED mode,
fonts, proxy settings, and more β€” all in one Tweaks screen.").
πŸ€– 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.

Outside diff comments:
In `@README.md`:
- Line 276: Remove the stale "liquid glass effects" mention from the FAQ
sentence that currently reads "Theme colors, AMOLED mode, fonts, liquid glass
effects, proxy settings, and more β€” all in one Tweaks screen." in the README;
edit the sentence in the Tweaks FAQ entry to omit "liquid glass effects" and
adjust punctuation so it reads naturally (e.g., "Theme colors, AMOLED mode,
fonts, proxy settings, and more β€” all in one Tweaks screen.").

ℹ️ Review info
βš™οΈ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: b56a226d-97e4-4efc-b59c-fadfd9e2abe3

πŸ“₯ Commits

Reviewing files that changed from the base of the PR and between c69e8e5 and 68fdf14.

πŸ“’ Files selected for processing (1)
  • README.md

@rainxchzed rainxchzed merged commit fde598f into main May 6, 2026
1 check passed
@rainxchzed rainxchzed deleted the chore/readme-feature-sync branch May 6, 2026 07:12
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.

Failed to connect to the Github when using Watt Toolkit to accelerate

1 participant