openai / openai/codex

[docs] codex-universal README runtime list has drifted from the Dockerfile

Open Beginner friendly
#40,193 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

CLI documentation
Dominant language
Rust
Stars
125k
Forks
19.4k
PR merge metrics
PR metrics pending

Description

What is the type of issue?

Documentation is incorrect

What is the issue?
What is the type of issue?
  • Documentation is incorrect
  • Example code is not working
What is the issue?

The runtime information in the openai/codex-universal README has drifted
from the current Dockerfile. I checked the fetched main commit
47f4f0eb5337083e2f610db0d15558932cb4901d.

Current mismatches:

  • The README says "OpenJDK 10 is not available on amd64". The Dockerfile
    instead excludes OpenJDK 11 on arm64, includes 11 on amd64, and documents
    that distinction in its adjacent comment.
  • The README lists Node.js 18, 20, and 22. The Dockerfile installs and verifies
    Node.js 24 as well.
  • The README lists PHP 8.4, 8.3, and 8.2. The Dockerfile installs and verifies
    PHP 8.5 as well.
  • The README lists Bun 1.2.10. The Dockerfile sets Bun 1.2.14.
  • The introduction contains the typo cutomize.

Source links at the frozen commit:

Suggested change

Please update the README to match the Dockerfile:

  • describe OpenJDK 11 as unavailable on arm64;
  • add Node.js 24 and PHP 8.5;
  • change Bun to 1.2.14; and
  • fix cutomize to customize.

A lightweight documentation check that compares the documented runtime list
with the Docker build/verification arguments could prevent the table from
drifting again.

Duplicate check

I searched all-state Issues and PRs in both openai/codex and
openai/codex-universal using the runtime names, versions, README paths, and
the codex-universal repository name.

  • openai/codex-universal PR #75 proposed only the older Bun documentation
    update and was closed as stale without merging.
  • PR #53 proposed only the spelling correction and was closed as stale without
    merging.
  • PR #55 included the same spelling correction plus a MitM proxy note and was
    closed without merging.
  • I did not find a current Issue or active PR covering the combined README
    drift above.

This is being filed in the main Codex tracker because the
codex-universal contribution guidance and a maintainer comment direct bug
reports and feature requests there.

Where did you find it?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the runtime table and architecture note in README.md, then compare them with the Node.js/Bun, Java, PHP, and verification sections of the Dockerfile at the cited commit. Update the README so its versions, arm64 Java note, and spelling match the Dockerfile; done means all listed mismatches are corrected.

Written by the indexing model from the issue text.

Assessment

Tech stack
bun, docker, java, node.js, php
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Active
Clarity
Clearly specified
Newbie friendliness
90/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.