docs: capture upstream README sync guidance#44
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (6)
📝 WalkthroughWalkthroughThis PR adds a docs-review configuration to fork-sync policy and extends user-facing docs with hardened-system workarounds, Electron build/download knobs, an opt-in Linux feature registry, Linux Computer Use runtime/verification steps, and expanded troubleshooting. ChangesDocumentation and fork-sync policy updates
Sequence Diagram(s)sequenceDiagram
participant SyncAgent as Sync Agent
participant UpstreamRepo as Upstream Repo
participant SyncLedger as Sync Ledger
participant Maintainer as Fork Maintainer
SyncAgent->>UpstreamRepo: fetch README / usage docs
SyncAgent->>SyncLedger: record missing-skill fallback + doc comparison results
SyncAgent->>Maintainer: surface unresolved items in PR body
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 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 |
|
| Filename | Overview |
|---|---|
| .agents/fork-sync-policy.toml | Adds [docs_review] section formalizing upstream README comparison requirements, with well-structured classify_readme_relevant_additions labels. |
| AGENTS.md | Adds one sentence directing agents to compare upstream README/usage docs and adapt relevant facts under local names; minimal and correct. |
| README.md | Adds feature table rows for Chrome native host and optional Linux features, /tmp noexec and Electron mirror notes, dev-app side-by-side build section, Computer Use runtime readiness info, and quick-start bullets; all cross-references resolve correctly. |
| docs/maintainers/fork-sync-policy.md | Inserts new step 8 for upstream docs review, renumbers steps 8–13 to 9–14 correctly, and expands the sync ledger and divergence guidance sections. |
| docs/usage/build-and-run.md | Adds zypper to supported package managers, /tmp noexec workaround, Electron mirror/headers docs, dev-app build overrides, Optional Linux Features section, and Computer Use runtime readiness commands; all relative links verified correct. |
| docs/usage/troubleshooting.md | Adds six new troubleshooting rows covering /tmp noexec, Electron download failures, Computer Use UI visibility, ydotool permissions, and AT-SPI; content is accurate and consistent with build-and-run.md and README.md. |
Reviews (3): Last reviewed commit: "docs: capture upstream README sync guida..." | Re-trigger Greptile
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
nisavid
force-pushed
the
nisavid/readme-upstream-guidance
branch
from
acb0b74 to
0df0b06
Compare
There was a problem hiding this comment.
Pull request overview
This PR expands the fork’s user-facing documentation to capture upstream README “product facts” (optional linux-features/, Chrome native host, Computer Use readiness, hardened /tmp noexec workarounds, Electron mirrors, and side-by-side dev builds) while translating them into this repo’s local codex-app identity/contracts. It also updates maintainer/agent sync policy to explicitly require reviewing upstream README and other user-facing docs during upstream syncs.
Changes:
- Document additional supported surfaces and build/runtime knobs in
README.md(Chrome native host, optional linux-features,/tmp noexec, Electron mirrors, dev builds, Computer Use readiness commands). - Expand
docs/usage/*with troubleshooting entries and build guidance for hardened/tmp, Electron mirrors, optional features, and Computer Use readiness. - Add an explicit “upstream README/user-facing docs review” checkpoint to maintainer/agent sync policy (
AGENTS.md,docs/maintainers/fork-sync-policy.md,.agents/fork-sync-policy.toml).
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| README.md | Adds user-facing feature/support notes and practical build/troubleshooting guidance (mirrors, dev builds, optional features, Computer Use readiness). |
| docs/usage/troubleshooting.md | Adds troubleshooting rows for hardened /tmp, Electron download issues, and Computer Use diagnostics. |
| docs/usage/build-and-run.md | Adds hardened /tmp workaround snippet, Electron mirror knobs, dev build targets, optional features overview, and Computer Use readiness commands. |
| docs/maintainers/fork-sync-policy.md | Requires upstream README/user-facing doc review and classification in sync workflow + ledger. |
| AGENTS.md | Adds an agent-facing reminder to compare/adapt upstream README/user docs under local contracts during syncs. |
| .agents/fork-sync-policy.toml | Introduces a [docs_review] section enumerating required upstream/local docs and classification buckets. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
![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: 0df0b066ed
ℹ️ About Codex in GitHub
Codex has been enabled to automatically 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 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
nisavid
force-pushed
the
nisavid/readme-upstream-guidance
branch
2 times, most recently
from
c459b2e to
a91fbeb
Compare
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 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 `@docs/usage/troubleshooting.md`:
- Around line 65-66: Update the two troubleshooting table rows that mention
"ydotoold", "ydotool_socket", and "/dev/uinput" to include example group names
(e.g., input, uinput, wheel, plugdev) and a short note that names vary by
distribution; for example, change the first row's guidance to "Start ydotoold,
then add your user to the input/uinput (or distro-specific) group that can
access /dev/uinput and the daemon socket" and the second to "Make the ydotoold
socket group-readable by an input-capable group (common names: input, uinput,
plugdev, wheel) or check your distro's group for input devices."
- Line 67: Update the troubleshooting table row that references
./codex-app/resources/plugins/openai-bundled/plugins/computer-use/bin/codex-computer-use-linux
to explicitly state this fix is GNOME-specific: replace the current description
with a note that AT-SPI is a GNOME accessibility standard, instruct GNOME users
to run the listed setup command and restart the app, and add a short sentence
clarifying that non-GNOME desktops (KDE, XFCE, etc.) use different accessibility
mechanisms and may not populate AT-SPI trees.
🪄 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: ASSERTIVE
Plan: Pro
Run ID: ed6f143e-8570-41f6-afe6-e63e11f1f805
📒 Files selected for processing (6)
.agents/fork-sync-policy.tomlAGENTS.mdREADME.mddocs/maintainers/fork-sync-policy.mddocs/usage/build-and-run.mddocs/usage/troubleshooting.md
Incorporate user-facing README facts that upstream added around optional Linux features, Chrome native host support, Computer Use readiness, noexec temporary directories, Electron mirrors, and side-by-side dev builds. Extend fork-sync policy so upstream README and usage docs are reviewed as product facts and translated through local contracts during future syncs. Co-authored-by: Codex <noreply@openai.com>
nisavid
force-pushed
the
nisavid/readme-upstream-guidance
branch
from
a91fbeb to
83d04f7
Compare
Summary
ilysenko/codex-desktop-linuxbut underrepresented here: optionallinux-features/, Chrome native host support, Computer Use host readiness, hardened/tmp noexecworkarounds, Electron mirrors, and side-by-side dev builds.codex-appnames, paths, updater identity, and docs structure instead of copying upstream wording wholesale.AGENTS.md,.agents/fork-sync-policy.toml, anddocs/maintainers/fork-sync-policy.mdso future sync ledgers classify readme-relevant upstream additions.Verification
git diff --checkpassed.rg -n 'codex-update-manager|~/.config/codex-desktop|/opt/codex-desktop|dist/codex-desktop_|dist/codex-desktop-|github:ilysenko/codex-desktop-linux' README.md docs/usage AGENTS.md docs/maintainers/fork-sync-policy.md .agents/fork-sync-policy.tomlreturned no matches.rg -n 'It gives|few practical|the Linux fork|Linux fork' README.md docs/usage AGENTS.md docs/maintainers/fork-sync-policy.md .agents/fork-sync-policy.tomlreturned only the intentionalAGENTS.mdprohibition.Docs-only change; no build gate needed.
Summary by CodeRabbit
New Features
Documentation