Repository navigation
Split the README into a short front page and agent-facing docs - #96
Conversation
Lead with what ControlFreak does and will not do, and what the user sees while an agent is in control. Move exact tool behavior under one detailed section, document download verification and the new session error codes, link the privacy policy, and fix the Pi manual configuration path.
The README keeps the header, capabilities, two at-a-glance tables, a three-step install with the files setup changes, privacy and links. Exact tool behavior, sessions and full install details move to docs/ as short reference pages. Development notes stay in CONTRIBUTING.md.
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 1c71a5e6c2
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
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".
| STDIO. The agent can take screenshots, read text with the Windows OCR engine on your computer, | ||
| and click, scroll and type in one window that it chose. | ||
|
|
||
| [Install](#install) · [Documentation](docs/README.md) · [Privacy](PRIVACY.md) · |
There was a problem hiding this comment.
When README.md is opened from either the installed directory or portable ZIP, this documentation link—and the new logo link—points to files that are absent: xtask/src/package.rs stages only its six top-level DOCUMENTS, while packaging/windows/controlfreak.iss installs neither docs/ nor assets/. Because this commit removes the self-contained reference from the README in favor of these links, packaged users lose the tool, session, and detailed setup documentation and see a broken logo; include these directories in both package formats or use links that remain valid outside the repository.
Useful? React with 👍 / 👎.
There was a problem hiding this comment.
Fixed in 6defced. The installer and the ZIP ship README.md without docs/ or assets/, so the logo and every docs/ link in the README now use their GitHub URLs on main, and they work in a packaged copy. The README's other links (PRIVACY.md, CHANGELOG.md, LICENSE, SECURITY.md) point to files that are packaged, so they stay relative.
Note
From claude-opus-5-5
| | Codex | `%USERPROFILE%\.codex\config.toml` | | ||
| | Claude Desktop | `%APPDATA%\Claude\claude_desktop_config.json` | | ||
| | OpenCode | `%USERPROFILE%\.config\opencode\opencode.json` | | ||
| | Pi | `%USERPROFILE%\.pi\agent\mcp.json` | |
There was a problem hiding this comment.
This changes the published Pi configuration path from the previous manual setup guidance, but CHANGELOG.md has no corresponding Unreleased entry. Add the correction there so users and generated release notes surface this setup change as required by the repository's delivery convention.
AGENTS.md reference: AGENTS.md:L74-L74
Useful? React with 👍 / 👎.
There was a problem hiding this comment.
Fixed in 6defced. Unreleased now records the corrected Pi setup path under Fixed, and the move of detailed documentation to docs/ under Changed.
Note
From claude-opus-5-5
The installer and ZIP ship README.md without docs/ or assets/, so the logo and documentation links now use their GitHub URLs on main. The changelog records the docs/ split and the corrected Pi setup path.
1 participant
What changed
The README is now a short front page for people. The detailed reference moved to
docs/for agents and client authors.README
docs/
tools.md: all 27 tools, targets, coordinates, OCR matching, waits, batches, result fields and session error codes.sessions.md: the session lifecycle, the indicator, stopping and elevated mode.install.md: what setup changes, upgrade, uninstall, silent install, portable ZIP, download verification, manual client setup and build from source.Assets
assets/logo.png: transparent logo.assets/social-preview.png: the 1280x640 social preview banner. GitHub's API cannot set it, so it has to be uploaded in the repository settings.Fixes found while rewriting
%USERPROFILE%\.pi\agent\mcp.json, not.config\mcp\mcp.json.statusvalues now includecompleted.AGENTS.md now points contributors to
docs/for behavior changes.Closes #43. PRIVACY.md merged in #92, and this PR links it from the README.
Checks
make check: not run. Documentation and images only, no code changes.Note
From claude-opus-5-5