core-agent-ide/docs
Robby He 372de6d2c5
docs: add developer_instructions config option and update descriptions (#8376)
Updates the configuration documentation to clarify and improve the
description of the `developer_instructions` and `instructions` fields.

Documentation updates:

* Added a description for the `developer_instructions` field in
`docs/config.md`, clarifying that it provides additional developer
instructions.
* Updated the comments in `docs/example-config.md` to specify that
`developer_instructions` is injected before `AGENTS.md`, and clarified
that the `instructions` field is ignored and that `AGENTS.md` is
preferred.

___

ref #7973 

Thanks to @miraclebakelaser for the message. I have double-confirmed
that developer instructions are always injected before user
instructions. According to the source code
[codex_core::codex::Session::build_initial_context](https://github.com/openai/codex/blob/rust-v0.77.0-alpha.2/codex-rs/core/src/codex.rs#L1279),
we can see the specific order of these instructions.
2025-12-22 07:37:37 -07: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 docs: add developer_instructions config option and update descriptions (#8376) 2025-12-22 07:37:37 -07:00
contributing.md remove release script (#7885) 2025-12-11 13:40:48 -08:00
example-config.md docs: add developer_instructions config option and update descriptions (#8376) 2025-12-22 07:37:37 -07:00
exec.md feat: arcticfox in the wild (#6906) 2025-11-19 16:31:06 +00:00
execpolicy.md fix: policy/*.codexpolicy -> rules/*.rules (#7888) 2025-12-11 14:46:00 -08:00
experimental.md Fix link to contributing.md in experimental.md (#8311) 2025-12-19 09:42:56 -08:00
faq.md docs: clarify xhigh reasoning effort on gpt-5.2 (#7911) 2025-12-11 21:18:47 -08:00
getting-started.md docs: clarify codex resume --all (CWD column & filtering) (#8264) 2025-12-18 16:54:50 +00:00
install.md docs: point dev checks to just (#7673) 2025-12-06 18:57:08 -08: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
sandbox.md chore: update windows sandbox docs (#6872) 2025-11-18 21:02:04 -08:00
skills.md Point skills docs to developer documentation site (#8407) 2025-12-21 16:18:58 -08:00
slash_commands.md feat: experimental menu (#8071) 2025-12-17 17:08:03 +00: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