chore: remove maintenance docs and trim README#20
Merged
Conversation
Delete the docs/maintenance/ tree (internal notes that do not belong in the repo). Trim the README to English only: keep the research-purpose disclaimer sentence and the Google Play warning, refresh the supported proxy protocols (native Mieru / Hysteria2 Gecko / MasterDnsVPN) and subscription formats, and remove the changelog/telegram, homepage, and donation sections. Credits and contributors are kept.
📝 WalkthroughSummary by CodeRabbitRelease Notes
Walkthrough
ChangesREADME and docs/maintenance cleanup
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Comment |
Owner
Author
|
@coderabbitai review |
✅ Action performedReview finished.
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
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 `@README.md`:
- Around line 33-35: Update the README documentation to clarify that Mieru
requires plugin initialization at runtime despite being marked as bundled. The
current line 191 states only Trojan-Go and NaïveProxy require external plugins,
but the actual code in BoxInstance.kt shows that MieruBean calls
initPlugin("mieru-plugin") just like the other protocols. Either add Mieru to
the list of protocols requiring plugin initialization on line 191, or revise the
bundled protocols descriptions to explicitly note that being bundled does not
eliminate the runtime plugin initialization requirement via initPlugin().
🪄 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
Run ID: 3e490de4-1410-48e7-a5ef-83b3dfb32a9e
📒 Files selected for processing (6)
README.mddocs/maintenance/dependency-audit.mddocs/maintenance/hysteria2-gecko-deferral.mddocs/maintenance/hysteria2-gecko-sidecar.mddocs/maintenance/masterdnsvpn-deferral.mddocs/maintenance/official-singbox-feasibility.md
💤 Files with no reviewable changes (5)
- docs/maintenance/official-singbox-feasibility.md
- docs/maintenance/hysteria2-gecko-deferral.md
- docs/maintenance/hysteria2-gecko-sidecar.md
- docs/maintenance/masterdnsvpn-deferral.md
- docs/maintenance/dependency-audit.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Repository housekeeping:
docs/maintenance/— internal maintenance notes that should notlive in the repo.
and MasterDnsVPN are now bundled).
No code or build changes.