core-agent-ide/docs
Robby He 57ba9fa100
fix(doc): TOML otel exporter example — multi-line inline table is inv… (#7669)
…alid (#7668)

The `otel` exporter example in `docs/config.md` is misleading and will
cause
the configuration parser to fail if copied verbatim.

Summary
-------
The example uses a TOML inline table but spreads the inline-table braces
across multiple lines. TOML inline tables must be contained on a single
line
(`key = { a = 1, b = 2 }`); placing newlines inside the braces triggers
a
parse error in most TOML parsers and prevents Codex from starting.

Reproduction
------------
1. Paste the snippet below into `~/.codex/config.toml` (or your project
config).
2. Run `codex` (or the command that loads the config).
3. The process will fail to start with a TOML parse error similar to:

```text
Error loading config.toml: TOML parse error at line 55, column 27
   |
55 | exporter = { otlp-http = {
   |                           ^
newlines are unsupported in inline tables, expected nothing
```

Problematic snippet (as currently shown in the docs)
---------------------------------------------------
```toml
[otel]
exporter = { otlp-http = {
  endpoint = "https://otel.example.com/v1/logs",
  protocol = "binary",
  headers = { "x-otlp-api-key" = "${OTLP_TOKEN}" }
}}
```

Recommended fixes
------------------
```toml
[otel.exporter."otlp-http"]
endpoint = "https://otel.example.com/v1/logs"
protocol = "binary"

[otel.exporter."otlp-http".headers]
"x-otlp-api-key" = "${OTLP_TOKEN}"
```

Or, keep an inline table but write it on one line (valid but less
readable):

```toml
[otel]
exporter = { "otlp-http" = { endpoint = "https://otel.example.com/v1/logs", protocol = "binary", headers = { "x-otlp-api-key" = "${OTLP_TOKEN}" } } }
```
2025-12-08 01:20:23 -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 fix(doc): TOML otel exporter example — multi-line inline table is inv… (#7669) 2025-12-08 01:20:23 -08:00
contributing.md docs: point dev checks to just (#7673) 2025-12-06 18:57:08 -08:00
example-config.md fix(doc): TOML otel exporter example — multi-line inline table is inv… (#7669) 2025-12-08 01:20:23 -08:00
exec.md feat: arcticfox in the wild (#6906) 2025-11-19 16:31:06 +00:00
execpolicy.md fix typo (#7626) 2025-12-04 21:48:15 -08:00
experimental.md docs: remove stale contribution reference (#5400) 2025-10-20 16:11:14 -07:00
faq.md docs: clarify codex max defaults and xhigh availability (#7449) 2025-12-01 10:46:53 -08:00
getting-started.md doc: fix relative links and add tips (#7319) 2025-11-26 09:35:08 -08: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
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
skills.md feat: experimental support for skills.md (#7412) 2025-12-01 20:22:35 -08:00
slash_commands.md add slash resume (#7302) 2025-12-03 11:25:44 -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