Skip to content

docs: sync README features with 1.7.0–1.8.1 reality#500

Merged
rainxchzed merged 2 commits into
mainfrom
docs/readme-feature-sync
May 4, 2026
Merged

docs: sync README features with 1.7.0–1.8.1 reality#500
rainxchzed merged 2 commits into
mainfrom
docs/readme-feature-sync

Conversation

@rainxchzed
Copy link
Copy Markdown
Member

@rainxchzed rainxchzed commented May 4, 2026

README's Features section had drifted across two release cycles. Audited against gh release view for 1.7.0/1.8.0/1.8.1 and against the actual codebase, then rewrote.

What changed

Features section additions (matching what we actually shipped):

  • Library Imports, Download Mirror System, APK Inspect, sectioned Apps screen.
  • What's new sheet, Announcements feed (1.8.1 path).
  • Sui silent install alongside Shizuku.
  • Personal Access Token sign-in.
  • In-app feedback under Tweaks β†’ About.
  • Pre-release channel chip + "switch to stable" rollback.
  • Backend at api.github-store.org for auth proxy / curated discovery / announcements feed.

Fixes:

  • Theme picker list β€” README claimed Ocean, Mint, Rose, Purple, Indigo, Peach, Dynamic. Actual AppTheme.kt enum: Dynamic, Ocean, Purple, Forest, Slate, Amber. Mint/Rose/Indigo/Peach do not exist.
  • .pkg.tar.zst added to supported Linux installer list (Arch / Manjaro / CachyOS).
  • Pros section now mentions Sui alongside Shizuku.
  • Two stale Discord vanity URLs (NBW4zeFcG6, x9Cvh2Z9qS) collapsed to canonical discord.github-store.org.
  • Business-inquiry email fixed from typo'd rainxch.dev@email.com to hello@github-store.org (matches CONTRIBUTING.md and CODE_OF_CONDUCT.md).
  • License copyright bumped to 2025-2026.

What's deliberately NOT in this PR

  • Localized README files (docs/README-*.md Γ— 11 locales) β€” same drift but translation cost is real. Better to leave a "translations needed" issue for the community than ship machine-translated drift across 11 files in a single PR. Ping me if you want a follow-up that does it anyway.
  • Wiki link β€” verified live (HTTP 200), kept as-is.
  • Discord embed code in the invidget badge β€” kept the existing real invite (NBW4zeFcG6); the vanity URL hides the real code, and changing the badge would break the embed without server-side info.

Test plan

  • Render README on GitHub web and confirm sections look correct.
  • Confirm theme list matches what users actually see in Tweaks β†’ Appearance.
  • Confirm both Discord links resolve to the same server.

Summary by CodeRabbit

  • Documentation
    • README updated with Smart discovery details, APK Inspect viewer, and expanded download mirror system with SHA-256 integrity checks, self-hosting, and slow-download suggestions.
    • Enhanced Rich details, App management, deep links, import/scan flows, pre-release toggle/rollback, and update/auto-update descriptions.
    • Added backend-routed device OAuth and personal access token sign-in, persistent β€œWhat’s new” history, anonymous announcements, theme options, Linux extension note, contact links, and license year update.

- Add Library Imports, Download Mirror System, APK Inspect, sectioned
  Apps screen, What's new sheet, Announcements feed, Sui silent install,
  PAT sign-in, in-app feedback, pre-release channel UX, backend section.
- Fix theme picker list to match AppTheme.kt (Dynamic, Ocean, Purple,
  Forest, Slate, Amber).
- Add .pkg.tar.zst to the supported Linux installer list.
- Mention Sui alongside Shizuku in Pros and App management.
- Collapse the two Discord vanity URLs to discord.github-store.org.
- Fix the business-inquiry email to hello@github-store.org.
- Bump license copyright to 2025-2026.
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 4, 2026

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
βš™οΈ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 70dc2de5-8928-4989-8644-d600a211f494

πŸ“₯ Commits

Reviewing files that changed from the base of the PR and between eba5631 and 034384b.

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

Walkthrough

This PR updates README.md feature documentation: documents a curated β€œSmart discovery” layer backed by the GitHub Store backend with GitHub passthrough fallback; adds APK Inspect and a download mirror system with SHA‑256 verification; expands Rich details, App management, Authentication, Cross‑version communication, Tweaks, Network & performance, FAQ, contact links, and updates copyright years.

Changes

README Feature & Messaging Update

Layer / File(s) Summary
Discovery & Feature Summary
README.md (lines ~130–152)
Documents curated β€œSmart discovery” backed by GitHub Store backend with live GitHub passthrough; adds APK Inspect and download mirror system (multi-source fetching, SHA‑256 verification, backend-updatable mirrors, self-hosted mirror support, opt-in slow-download suggestion).
Rich Details & Deep Linking
README.md (lines ~156–163)
Adds README translation rendering, pre-release channel toggling with β€œswitch to stable” rollback, merged β€œwhat’s changed” behavior, stronger deep-linking and developer profile navigation notes.
App Management & Install Flow
README.md (lines ~165–173, ~261–263)
Describes Library Imports (on-device GitHub app recognition & review wizard), Link apps flow, Shizuku/Sui silent install for hands-free updates, periodic background update checks and auto-update behavior.
Cross-version Communication & Announcements
README.md (lines ~180–183)
Adds first-launch β€œWhat’s new” sheet with persistent history and anonymous backend Announcements feed with local dismissal/read state.
Authentication & Backend Routing
README.md (lines ~184–187)
Documents backend-routed GitHub OAuth device-flow with infrastructure fallback and Personal Access Token sign-in option with local validation.
Tweaks, Network & Self-hosting Notes
README.md (lines ~188–203)
Updates settings/appearance/network/install/update/storage/send-feedback descriptions; documents anonymous backend at api.github-store.org and self-hosting note.
FAQ, Contact & Community Links
README.md (lines ~226–229, ~318–324, ~406–407, ~436–438)
Adds .pkg.tar.zst to supported Linux extensions; replaces Discord invite links with https://discord.github-store.org; updates business inquiries email to hello@github-store.org.
Metadata / License
README.md (lines ~496–498)
Bumps copyright header to Copyright 2025-2026.

Sequence Diagram(s)

(omitted β€” changes are documentation-only and do not introduce a multi-component control flow)

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Poem

🐰 I hopped through lines and polished text,
Mirrors, APK views, and backend specs,
Discord links redirected, years extended,
README sings β€” the doc is mended! πŸ₯•

πŸš₯ 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: sync README features with 1.7.0–1.8.1 reality' directly and clearly describes the main change: updating README documentation to reflect actual features shipped in app versions 1.7.0 through 1.8.1.
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-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
Review rate limit: 7/8 reviews remaining, refill in 7 minutes and 30 seconds.

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.

Actionable comments posted: 1

πŸ€– Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@README.md`:
- Around line 149-151: Replace the two nonstandard spellings in the README
bullets: change "Curated community mirror list, updateable from the backend
without an app release." to use "updatable" instead of "updateable", and change
"Auto-suggest sheet after sustained slow downloads β€” opt in with one tap,
dismissable, never nags." to use "dismissible" instead of "dismissable"; update
the exact strings in the README so other text remains unchanged.
πŸͺ„ 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: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 906608da-263d-4058-a18a-748ac0591321

πŸ“₯ Commits

Reviewing files that changed from the base of the PR and between 3459f1f and eba5631.

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

Comment thread README.md Outdated
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
@rainxchzed rainxchzed merged commit a806644 into main May 4, 2026
1 check was pending
@rainxchzed rainxchzed deleted the docs/readme-feature-sync branch May 4, 2026 03:02
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