Commit Graph

11 Commits

  • Prefer just test over cargo test in docs (#23910)
    `cargo test` for the core and other crates fails on a fresh macOS
    checkout without the right stack size variable. This change encourages
    using the just test command that sets the environment up correctly.
    
    As a bonus, this should encourage agents to get more benefit out of
    nextest's parallel execution.
  • [Codex][CLI] Gate image inputs by model modalities (#10271)
    ###### Summary
    
    - Add input_modalities to model metadata so clients can determine
    supported input types.
    - Gate image paste/attach in TUI when the selected model does not
    support images.
    - Block submits that include images for unsupported models and show a
    clear warning.
    - Propagate modality metadata through app-server protocol/model-list
    responses.
      - Update related tests/fixtures.
    
      ###### Rationale
    
      - Models support different input modalities.
    - Clients need an explicit capability signal to prevent unsupported
    requests.
    - Backward-compatible defaults preserve existing behavior when modality
    metadata is absent.
    
      ###### Scope
    
      - codex-rs/protocol, codex-rs/core, codex-rs/tui
      - codex-rs/app-server-protocol, codex-rs/app-server
      - Generated app-server types / schema fixtures
    
      ###### Trade-offs
    
    - Default behavior assumes text + image when field is absent for
    compatibility.
      - Server-side validation remains the source of truth.
    
      ###### Follow-up
    
    - Non-TUI clients should consume input_modalities to disable unsupported
    attachments.
    - Model catalogs should explicitly set input_modalities for text-only
    models.
    
      ###### Testing
    
      - cargo fmt --all
      - cargo test -p codex-tui
      - env -u GITHUB_APP_KEY cargo test -p codex-core --lib
      - just write-app-server-schema
    - cargo run -p codex-cli --bin codex -- app-server generate-ts --out
    app-server-types
      - test against local backend
      
    <img width="695" height="199" alt="image"
    src="https://github.com/user-attachments/assets/d22dd04f-5eba-4db9-a7c5-a2506f60ec44"
    />
    
    ---------
    
    Co-authored-by: Josh McKinney <joshka@openai.com>
  • Replaced user documentation with links to developers docs site (#8662)
    This eliminates redundant user documentation and allows us to focus our
    documentation investments.
    
    I left tombstone files for most of the existing ".md" docs files to
    avoid broken links. These now contain brief links to the developers docs
    site.
  • docs: point dev checks to just (#7673)
    Update install and contributing guides to use the root justfile helpers
    (`just fmt`, `just fix -p <crate>`, and targeted tests) instead of the
    older cargo fmt/clippy/test instructions that have been in place since
    459363e17b. This matches the justfile relocation to the repo root in
    952d6c946 and the current lint/test workflow for CI (see
    `.github/workflows/rust-ci.yml`).
  • Updated contributing guidelines and PR template to request link to bug report in PR notes (#6332)
    Some PRs are being submitted without reference to existing bug reports
    or feature requests. This updates the PR template and contributing
    guidelines to request that all PRs from the community contain such a
    link. This provides additional context and helps prioritize, track, and
    assess PRs.
  • docs: fix broken link in contributing guide (#4973)
    ## Summary
    
    This PR fixes a broken self-referencing link in the contributing
    documentation.
    
    ## Changes
    
    - Removed the phrase 'Following the [development
    setup](#development-workflow) instructions above' from the Development
    workflow section
    - The link referenced a non-existent section and the phrase didn't make
    logical sense in context
    
    ## Before
    
    The text referenced 'development setup instructions above' but:
    1. No section called 'development setup' exists
    2. There were no instructions 'above' that point
    3. The link pointed to the same section it was in
    
    ## After
    
    Simplified to: 'Ensure your change is free of lint warnings and test
    failures.'
    
    ## Type
    
    Documentation fix
    
    
    I have read the CLA Document and I hereby sign the CLA
    
    Co-authored-by: Ritesh Chauhan <sagar.chauhn11@gmail.com>
  • Update Homebrew install instructions to use cask (#5377)
    ## Summary
    - update the README install snippets to use `brew install --cask codex`
    - mirror the same change in the Rust CLI README
    
    Address #5317
    
    https://chatgpt.com/codex/tasks/task_i_68f65682543083269254cd64d290df28
    
    ---------
    
    Co-authored-by: pakrym-oai <pakrym@openai.com>
  • chore: subject docs/*.md to Prettier checks (#4645)
    Apparently we were not running our `pnpm run prettier` check in CI, so
    many files that were covered by the existing Prettier check were not
    well-formatted.
    
    This updates CI and formats the files.
  • README / docs refactor (#2724)
    This PR cleans up the monolithic README by breaking it into a set
    navigable pages under docs/ (install, getting started, configuration,
    authentication, sandboxing and approvals, platform details, FAQ, ZDR,
    contributing, license). The top‑level README is now more concise and
    intuitive, (with corrected screenshots).
    
    It also consolidates overlapping content from codex-rs/README.md into
    the top‑level docs and updates links accordingly. The codex-rs README
    remains in place for now as a pointer and for continuity.
    
    Finally, added an extensive config reference table at the bottom of
    docs/config.md.
    
    ---------
    
    Co-authored-by: easong-openai <easong@openai.com>