Focus README on consumers#4
Conversation
Co-authored-by: Claude <noreply@anthropic.com> Co-authored-by: GitButler <gitbutler@gitbutler.com>
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request restructures the documentation by streamlining the main README.md to focus on user-facing installation, features, and settings, while moving detailed contributor, development, and release guidelines into a new docs/development.md file. The review feedback suggests replacing a literal ellipsis in an example code signing command with a clearer placeholder to prevent copy-paste errors.
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.
There was a problem hiding this comment.
Pull request overview
This PR reshapes the top-level documentation to be consumer-first, moving contributor/maintainer details out of the README while preserving a short “dev loop” path for developers.
Changes:
- Rewrites
README.mdto prioritize Homebrew installation, consumer usage model, and settings. - Adds
docs/development.mdto house contributor setup, project structure, and the detailed release/CI secrets documentation. - Updates README to link to the new development and release guide.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| README.md | Reordered and rewrote README content to emphasize install + everyday usage, with a link to contributor/release details. |
| docs/development.md | New contributor/maintainer guide consolidating build/test, run/install, structure, and release process details. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
@codex review |
|
Codex Review: Didn't find any major issues. You're on a roll. Reviewed commit: ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
If Codex has suggestions, it will comment; otherwise it will react with 👍. Codex can also answer questions or update the PR. Try commenting "@codex address that feedback". |
Co-authored-by: Claude <noreply@anthropic.com> Co-authored-by: GitButler <gitbutler@gitbutler.com>
Summary
Why
The README was primarily a developer reference and did not tell consumers how to install the app. This follows the consumer-first shape of Claude Bar while retaining a short development loop and a clear path to the detailed maintainer documentation.
Impact
Consumers now get the install command, requirements, settings, and behavior without working through internal release configuration. Contributors keep the existing technical information in
docs/development.md.Validation
git diff --checkdocs/development.mdexists at the README link target