core-agent-ide/docs
lionel-oai 8b314e2d04
doc: fix relative links and add tips (#7319)
This PR is a documentation only one which:
- addresses the #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:

<img width="1198" height="849" alt="Screenshot 2025-11-26 at 16 25 31"
src="https://github.com/user-attachments/assets/308d33c3-81d3-4785-a6c1-e9377e6d3ea6"
/>

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:

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

---------

Signed-off-by: lionel-oai <lionel@openai.com>
Signed-off-by: lionelchg <lionel.cheng@hotmail.fr>
Co-authored-by: lionelchg <lionel.cheng@hotmail.fr>
2025-11-26 09:35:08 -08:00
..
advanced.md doc: fix relative links and add tips (#7319) 2025-11-26 09:35:08 -08:00
agents_md.md docs: fix agents fallback example (#5396) 2025-10-22 11:32:35 -07:00
authentication.md chore: subject docs/*.md to Prettier checks (#4645) 2025-10-03 11:35:48 -07:00
CLA.md chore: subject docs/*.md to Prettier checks (#4645) 2025-10-03 11:35:48 -07:00
config.md Allow enterprises to skip upgrade checks and messages (#7213) 2025-11-24 15:04:49 -05:00
contributing.md Updated contributing guidelines and PR template to request link to bug report in PR notes (#6332) 2025-11-06 12:02:39 -08:00
example-config.md Removed streamable_shell from docs (#7235) 2025-11-24 11:47:57 -08:00
exec.md feat: arcticfox in the wild (#6906) 2025-11-19 16:31:06 +00:00
execpolicy.md move execpolicy quickstart (#7127) 2025-11-21 19:13:51 -05:00
experimental.md docs: remove stale contribution reference (#5400) 2025-10-20 16:11:14 -07:00
faq.md Update faq.md section on supported models (#6832) 2025-11-18 09:38:45 -08:00
getting-started.md doc: fix relative links and add tips (#7319) 2025-11-26 09:35:08 -08:00
install.md chore: subject docs/*.md to Prettier checks (#4645) 2025-10-03 11:35:48 -07:00
license.md chore: subject docs/*.md to Prettier checks (#4645) 2025-10-03 11:35:48 -07:00
open-source-fund.md chore: subject docs/*.md to Prettier checks (#4645) 2025-10-03 11:35:48 -07:00
platform-sandboxing.md doc: fix relative links and add tips (#7319) 2025-11-26 09:35:08 -08:00
prompts.md Fix documentation errors for Custom Prompts named arguments and add canonical examples (#5910) 2025-11-15 09:25:46 -08:00
release_management.md Update Homebrew install instructions to use cask (#5377) 2025-10-20 17:43:40 +00:00
sandbox.md chore: update windows sandbox docs (#6872) 2025-11-18 21:02:04 -08:00
slash_commands.md Add documentation for slash commands in docs/slash_commands.md. (#5685) 2025-11-03 08:27:13 -08:00
windows_sandbox_security.md Windows: flag some invocations that launch browsers/URLs as dangerous (#7111) 2025-11-21 13:36:17 -08:00
zdr.md Never store requests (#3212) 2025-09-05 10:41:47 -07:00