Skip to content

docs: shorten README and fix review auth#2

Merged
QueryPlanner merged 2 commits into
mainfrom
codex/shorten-readme
Jun 13, 2026
Merged

docs: shorten README and fix review auth#2
QueryPlanner merged 2 commits into
mainfrom
codex/shorten-readme

Conversation

@QueryPlanner

@QueryPlanner QueryPlanner commented Jun 13, 2026

Copy link
Copy Markdown
Owner

What

Shorten the README, improve scanning with emojis, and repair OpenCode PR review authentication.

Why

The documentation repeated several usage details, and OpenCode could not publish reviews because its GitHub App token exchange failed.

How

  • Consolidate installation and playback instructions
  • Preserve commands, controls, requirements, and offline behavior
  • Add emoji headings to improve visual navigation
  • Use the GitHub Actions token for OpenCode comments
  • Grant issue and pull request write permissions
  • Run OpenCode when pull request commits change

Tests

  • Run git diff --check
  • Parse the OpenCode workflow as YAML
  • Run uv run binge-docs --help
  • Verify documented commands against CLI help

Related Issues

None.

- Condense setup and usage guidance
- Add emoji headings for faster scanning

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Code Review

This pull request refactors and condenses the README.md file to make it more concise, adding emojis to headers and streamlining instructions. A review comment correctly points out that removing the explicit instruction to clone the repository before running uv tool install . could lead to failures, and suggests restoring that instruction.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment thread README.md
Comment on lines +9 to +10
Requires Python 3.10–3.13, internet access for initial downloads, and audio
output.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

The instruction to clone the repository was removed in this revision. Running uv tool install . directly will fail if the user has not already cloned the repository and navigated into its directory. It is recommended to explicitly instruct the user to clone the repository first.

Suggested change
Requires Python 3.10–3.13, internet access for initial downloads, and audio
output.
Requires Python 3.10–3.13, internet access for initial downloads, and audio\noutput. Clone this repository and run:

- Use the GitHub Actions token for review comments
- Grant issue and pull request write permissions
@QueryPlanner QueryPlanner merged commit 6aeb3a2 into main Jun 13, 2026
@QueryPlanner QueryPlanner changed the title docs: shorten README with emojis docs: shorten README and fix review auth Jun 13, 2026
@QueryPlanner QueryPlanner mentioned this pull request Jun 13, 2026
3 tasks
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