README intro has nested paragraph markup

Resolved 💬 2 comments Opened May 21, 2026 by Zacxxx Closed May 26, 2026

💡 Likely answer: A maintainer (etraut-openai, contributor) responded on this thread — see the highlighted reply below.

What is the type of issue?

Documentation is incorrect / Documentation is confusing

What is the issue?

The top README intro opens a centered paragraph for the Codex CLI sentence, then opens another  for the splash image before closing the first paragraph.

The same block also uses closing  tags. GitHub's renderer is forgiving, but the markup is invalid HTML and can be fragile when copied into downstream docs renderers.

Expected cleanup: close the intro paragraph before the splash image and use   or normal Markdown spacing instead of .

Where did you find it?

https://github.com/openai/codex/blob/main/README.md

View original on GitHub ↗

2 Comments

yui-stingray · 3 months ago

I checked current main, and this still reproduces in README.md: the centered intro paragraph remains open before the splash image paragraph starts, and the intro block still uses closing  tags.

A minimal docs-only cleanup would be:

-<p align="center"><strong>Codex CLI</strong> is a coding agent from OpenAI that runs locally on your computer.
+<p align="center"><strong>Codex CLI</strong> is a coding agent from OpenAI that runs locally on your computer.</p>
 <p align="center">
   <img src="https://github.com/openai/codex/blob/main/.github/codex-cli-splash.png" alt="Codex CLI splash" width="80%" />
 </p>
-</br>
-If you want Codex in your code editor (VS Code, Cursor, Windsurf), <a href="https://developers.openai.com/codex/ide">install in your IDE.</a>
-</br>If you want the desktop app experience, run <code>codex app</code> or visit <a href="https://chatgpt.com/codex?app-landing-page=true">the Codex App page</a>.
-</br>If you are looking for the <em>cloud-based agent</em> from OpenAI, <strong>Codex Web</strong>, go to <a href="https://chatgpt.com/codex">chatgpt.com/codex</a>.</p>
+<p align="center">If you want Codex in your code editor (VS Code, Cursor, Windsurf), <a href="https://developers.openai.com/codex/ide">install in your IDE.</a><br />If you want the desktop app experience, run <code>codex app</code> or visit <a href="https://chatgpt.com/codex?app-landing-page=true">the Codex App page</a>.<br />If you are looking for the <em>cloud-based agent</em> from OpenAI, <strong>Codex Web</strong>, go to <a href="https://chatgpt.com/codex">chatgpt.com/codex</a>.</p>

Suggested validation for this docs-only change:

pnpm exec prettier --check README.md
git diff --check

Sharing this as an issue-side patch sketch rather than opening an unsolicited PR, since docs/contributing.md says external PRs are by invitation only.

etraut-openai contributor · 3 months ago

I don't think this is causing any problems.