8 Commits

• 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.

  Eric Traut · 2026-01-02 13:01:53 -07:00
  ab753387cc
• remove release script (#7885)
  Ahmed Ibrahim · 2025-12-11 13:40:48 -08:00
  c4f3f566a5
• 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`).

  Victor · 2025-12-06 18:57:08 -08:00
  b2cb05d562
• 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.

  Eric Traut · 2025-11-06 12:02:39 -08:00
  fe7eb18104
• 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>

  Ritesh Chauhan · 2025-10-31 15:09:35 -07:00
  d7f8b97541
• 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>

  Shijie Rao · 2025-10-20 17:43:40 +00:00
  73a1787eb8
• 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.

  Michael Bolin · 2025-10-03 11:35:48 -07:00
  c32e9cfe86
• 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>

  Reuben Narad · 2025-08-27 10:30:39 -07:00
  459363e17b