Skip to content

docs: improve README setup and usage#106

Merged
owainlewis merged 2 commits into
mainfrom
codex/improve-readme
Jul 16, 2026
Merged

docs: improve README setup and usage#106
owainlewis merged 2 commits into
mainfrom
codex/improve-readme

Conversation

@owainlewis

Copy link
Copy Markdown
Owner

Summary

  • add an end-to-end quickstart with prerequisites, release and source installation, assistant setup, and first run
  • document common chat commands and job workflows
  • add concise contributor checks while preserving the product overview and canonical documentation links

Why

The README explained the product well but delegated most setup and usage details to the documentation site. This gives new users a concrete path from installation to a working gateway and makes common operations easier to find.

Test plan

  • cargo fmt --all --check
  • cargo clippy --locked --all-targets -- -D warnings
  • cargo build --locked
  • cargo test --locked (245 unit tests and 11 integration tests)
  • cargo build --locked --release
  • verified the documented source install into a fresh destination
  • bash tests/install.sh
  • mkdocs build --strict
  • git diff --check
  • checked 14 local README links and all external README links
  • inspected the rendered branch README on GitHub for structure, overflow, and console errors
  • independent subagent diff review completed; fixed its source-install finding and re-reviewed cleanly

Risks

Documentation-only change. A live Telegram or iMessage gateway was not started because that requires external account and platform state. Browser screenshots and a narrow viewport check were unavailable for the GitHub file view, but the rendered DOM had no page overflow or console errors.

Related issue

None.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 766d4177df

ℹ️ 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".

Comment thread README.md
[Claude Code](https://docs.anthropic.com/en/docs/claude-code/overview), or
[Pi](https://pi.dev/) installed, authenticated, and runnable by the user that
will run Push
- `curl` and `tar` for the release installer

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Add Git to the quickstart prerequisites

For users installing the prebuilt release on a machine without git, following this Quickstart reaches push init, which unconditionally executes git init in src/assistant.rs, so setup fails even though all listed requirements are satisfied. Please include Git in the general requirements rather than only the source-build paragraph.

Useful? React with 👍 / 👎.

@owainlewis
owainlewis merged commit 2b60f0b into main Jul 16, 2026
3 checks passed
@owainlewis
owainlewis deleted the codex/improve-readme branch July 16, 2026 12:47
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