Skip to content

Conversation

@lionel-oai
Copy link
Contributor

This PR is a documentation only one which:

  • addresses the Tries to use Python when only Python3 available #7231 by adding a paragraph in docs/getting-started.md in the tips category to encourage users to load everything needed in their environment
  • corrects link referencing in docs/platform-sandboxing.md so that the page link opens at the right section
  • removes the explicit heading IDs like {#my-id} in docs/advanced.md which are not supported by GitHub and are not rendered in the UI:
Screenshot 2025-11-26 at 16 25 31

This caused the following links in README.md to not work in main but to work in this branch (you can test by going to https://github.com/openai/codex/blob/docs/getting-started-enhancement/README.md) - the MCP link goes straight to the correct section now:

  - [**Advanced**](./docs/advanced.md)
  - [Tracing / verbose logging](./docs/advanced.md#tracing--verbose-logging)
  - [Model Context Protocol (MCP)](./docs/advanced.md#model-context-protocol-mcp)

@github-actions
Copy link

github-actions bot commented Nov 26, 2025

All contributors have signed the CLA ✍️ ✅
Posted by the CLA Assistant Lite bot.

@lionel-oai
Copy link
Contributor Author

I have read the CLA Document and I hereby sign the CLA

github-actions bot added a commit that referenced this pull request Nov 26, 2025
@lionel-oai lionel-oai added bug Something isn't working documentation Improvements or additions to documentation labels Nov 26, 2025
@etraut-openai etraut-openai merged commit 8b314e2 into main Nov 26, 2025
11 of 12 checks passed
@etraut-openai etraut-openai deleted the docs/getting-started-enhancement branch November 26, 2025 17:35
@github-actions github-actions bot locked and limited conversation to collaborators Nov 26, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

bug Something isn't working documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants