docs(readme): clarify Linux package quick start#50
Conversation
📝 WalkthroughWalkthroughThis PR reorganizes user-facing documentation: adds a "Start Here" navigation, standardizes Quick Start and native packaging steps, simplifies release-gate verification, clarifies Linux Computer Use readiness and troubleshooting across README and docs, and adds ChangesDocumentation Reorganization & Linux Computer Use Alignment
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 |
Document layout-sensitive keyboard input, sparse AT-SPI target apps, and datagram ydotool socket troubleshooting for Linux Computer Use. Co-authored-by: Codex <noreply@openai.com>
e522b0d to
07ccdd9
Compare
|
| Filename | Overview |
|---|---|
| .gitignore | Adds .impeccable/ to exclude local design-review critique snapshots from git status; minimal, correct change. |
| README.md | Major restructure: adds Start Here router, promotes package-managed Quick Start, condenses Feature Status table, adds Computer Use keyboard-layout note, and moves verbose blocks to linked docs. All internal anchors and Make targets verified. |
| docs/usage/build-and-run.md | Expands the Linux Computer Use UI Opt-In section with independent-path readiness framing and keyboard-layout debugging guidance. Anchor #linux-computer-use-ui-opt-in used in README is present and correct. |
| docs/usage/troubleshooting.md | Adds three new Computer Use rows and broadens the AT-SPI empty-tree entry from GNOME-only to a general sparse-tree note with NO_AT_BRIDGE check. |
Flowchart
%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[Start Here] --> B{Use case?}
B -->|Normal install| C[Quick Start]
B -->|NixOS| D[NixOS]
B -->|Custom DMG / checkout| E[Manual and Custom Builds]
B -->|AppImage / package details| F[Native Package Details]
B -->|Computer Use / updater / release| G[Linux Computer Use]
C --> H[Install distro package]
H --> I[codex-app]
G --> J{Readiness check}
J --> K[AT-SPI path]
J --> L[Screenshot portal path]
J --> M[Window / pointer path]
J --> N[Keyboard / ydotool path]
Reviews (2): Last reviewed commit: "docs(readme): clarify package quick star..." | Re-trigger Greptile
Lead with the normal package-managed build and install path, then route manual, NixOS, Computer Use, release, and maintainer details to focused sections. Ignore local Impeccable critique snapshots so design-review artifacts stay available without polluting git status. Co-authored-by: Codex <noreply@openai.com>
07ccdd9 to
ad17d0a
Compare
Summary
Start Hererouter and makes the normal package-managed path the first path.make clean build-app package, distro package-manager install commands, andcodex-applaunch..impeccable/critique snapshots so design-review artifacts do not pollutegit status.Verification
git diff --check "$(git merge-base origin/main HEAD)"..HEADpassed.~/.codex/AGENTS.mdinstruction text; no valid findings.origin/main, preserving the newer AppImage, bootstrap-native, remote-control, NixOS-output, and Fedora ydotool notes.REQUIRE_RELEASE_SIGNATURE=1public-release behavior.Notes
~/.codex/AGENTS.mdComputer Use guidance is intentionally outside this repository and is not part of this PR.