docs: update README for v2.6.1

[Manabu-GT]

Summary

• Bump dependency coordinate examples in README from 2.6.0 to 2.6.1.
• Add CHANGELOG entry for v2.6.1 covering the speculative MIUI fix from [fix] drop FLAG_ACTIVITY_NEW_TASK when launching BugReportActivity from an Activity context #252; framed as exploratory since the symptom reported in [BUG] Create Report button is unresponsive when a report already exists #251 could not be reproduced on the maintainer's devices.

Test plan

• Visual review of CHANGELOG wording (especially the "speculative / exploratory" framing).
• Verify all 10 README version references read 2.6.1 and that links resolve.

🤖 Generated with Claude Code

Summary by CodeRabbit

• Bug Fixes

  • Fixed compatibility issue affecting Xiaomi/MIUI devices related to bug report activity launching, enhancing overall stability on these platforms.

• Documentation

  • Updated all installation guides and code examples to version 2.6.1, including Quick Start, Gradle, Kotlin DSL, and extension setup examples.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: ed524c0c-5dbd-4447-ac21-33caab59c813

📥 Commits

Reviewing files that changed from the base of the PR and between 05f5f52 and e83d065.

📒 Files selected for processing (2)

• CHANGELOG.md
• README.md

---

📝 Walkthrough

Walkthrough

This PR updates documentation for DebugOverlay version 2.6.1, adding a changelog entry that documents a bug fix for launching BugReportActivity on Xiaomi/MIUI devices and updating all README installation examples from version 2.6.0 to 2.6.1.

Changes

Release 2.6.1 documentation and changelog

Layer / File(s)	Summary
Changelog entry for version 2.6.1 CHANGELOG.md	New changelog section documents version 2.6.1 (2026-05-21) with a bug fix for Xiaomi/MIUI BugReportActivity launching: FLAG_ACTIVITY_NEW_TASK is no longer used when invoked from an Activity context but is retained for FAB overlay context.
README version updates to 2.6.1 README.md	All installation and dependency examples are updated from 2.6.0 to 2.6.1, including Quick Start Gradle snippet, Version Catalog entries, Kotlin DSL example, shake trigger extension, network OkHttp extension, Timber extension, and Advanced Setup configuration.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

• Manabu-GT/DebugOverlay-Android#252: Implements the conditional FLAG_ACTIVITY_NEW_TASK fix for BugReportActivity that is documented in this release changelog.

🚥 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 summarizes the main change: updating README documentation for version 2.6.1, which aligns with the primary scope of the changeset.
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-v2.6.1

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[claude]

Claude finished @Manabu-GT's task in 1m 32s —— View job

---

Review — docs only, ready to merge

This is a clean release-prep doc update: README versions and a new CHANGELOG entry for v2.6.1. I verified the substantive claims against the code and the underlying fix commit.

Test plan checklist (from PR description)

• All 10 2.6.0 → 2.6.1 references in README updated; no stragglers (grep "2\.6\.0" README.md returns empty; grep -c "2.6.1" README.md → 10)
• CHANGELOG technical claims accurate
  • BugReportActivity.kt:335,343 actually does if (context.findActivityOrNull() == null) addFlags(Intent.FLAG_ACTIVITY_NEW_TASK) — matches "flag is preserved for the FAB's non-Activity overlay context"
  • debugoverlay-core/src/main/AndroidManifest.xml:16 confirms BugReportActivity uses debugoverlay_Theme.Transparent — matches "transparent destination"
  • References issue #251, which is the symptom being addressed; consistent with style of prior entries that link the originating issue
• Date formatting *(2026-05-21)* matches the convention used by all prior entries; release date is one day before today's 2026-05-22, consistent with the cut-tag-today workflow

Wording feedback ("speculative / exploratory" framing)

The framing reads well. It does three useful things:

1. Leads with "Speculative fix" so users skimming the changelog know what they're getting
2. Explains why it might work (NEW_TASK + transparent destination → MIUI pop-up gate)
3. Closes with the honest caveat that [BUG] Create Report button is unresponsive when a report already exists #251 could not be reproduced locally

Faithfully mirrors the commit message and sets correct expectations for Xiaomi users without burying the change. No edits required.

Optional nits (non-blocking)

• The bullet is the longest in this CHANGELOG (~80 words vs. ~30–50 elsewhere). Acceptable given the nuance you're conveying, but if you wanted to trim, splitting the "what changed" and the "why uncertain" into two sentences with a paragraph break would parse faster. Current single-sentence form is fine.
• No link to the fix PR (#252). The project's existing style is to link the originating issue rather than the PR (see 2.6.0, 2.5.0, 2.3.0 entries), so this is consistent — flagging only in case you wanted to deviate this time since the issue remains open.

What I did not find

• No bugs / no security implications / no perf implications — pure docs change
• No CI workflow changes
• No accidental edits to non-README.md / CHANGELOG.md files (git diff --stat origin/main...HEAD confirms 2 files only)

LGTM as-is.
· Branch: docs/readme-v2.6.1

[github-actions]

Qodana for JVM

It seems all right 👌

No new problems were found according to the checks applied

💡 Qodana analysis was run in the pull request mode: only the changed files were checked
☁️ View the detailed Qodana report

Contact Qodana team

Contact us at qodana-support@jetbrains.com

• Or via our issue tracker: https://jb.gg/qodana-issue
• Or share your feedback: https://jb.gg/qodana-discussions