Skip to content

docs(codex): document the prompt-layer panel in eight locales - #2682

Merged
lidge-jun merged 2 commits into
devfrom
codex/prompt-layers-docs
Aug 26, 2026
Merged

lidge-jun merged 2 commits into
devfrom
codex/prompt-layers-docs

Conversation

@lidge-jun

Copy link
Copy Markdown
Owner

Summary

Documents the prompt-layer panel: what the stack is, the five kinds of layer and which of them you can actually switch, custom layers and where they land, presets as adaptations, and the timing rule — new sessions, not running ones.

It also states a limit the page depends on: opencodex reads one config layer out of the eight Codex merges, so the panel reports this file's values rather than the resolved Codex configuration.

Ships in English plus seven locales. devlog 070 specified English + four because astro.config.mjs declared four when it was written; the site now carries seven, so all seven ship rather than leaving three in a missing-translation state.

Top of the stack. No code changes, no gui/ paths.

Stack (merge bottom-up):

# PR Layer Review focus
5 docs ← you are here guide + 8 locales prose only
4 #2681 real prompt text, ordered stack probe correctness
3 #2680 custom layers, presets write races
2 #2679 Codex Set page rename + read path
1 #2678 /api/codex-prompt request policy

Depends on #2681. Review this PR's diff only.

Verification

  • cd docs-site && bun run build — exit 0, all locale pages generated including the new guide and its sidebar entry.
  • Korean copy follows the house rule: no translationese, one register throughout.

Checklist

  • Scope stays focused and avoids unrelated cleanup.
  • Docs or release notes were updated when needed.
  • Security-sensitive changes were reviewed for secrets, auth, and unsafe defaults.

Documentation only — no runtime, auth, or credential surface.

@lidge-jun
lidge-jun requested a review from Ingwannu as a code owner August 26, 2026 12:29
@coderabbitai

coderabbitai Bot commented Aug 26, 2026 •

Copy link
Copy Markdown
Contributor

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

🗂️ Base branches to auto review (2)
  • ^dev$
  • ^preview$

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 590ab67d-84ad-452d-ad5f-20e657e6a5b1

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@github-actions

Copy link
Copy Markdown
Contributor

✅ Deterministic PR hygiene checks passed.

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Aug 26, 2026

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 5e599b5217

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment on lines +49 to +50
The reading is taken from your global Codex home (`~/.codex`), not from whatever
directory the dashboard happens to be running in.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Describe the effective Codex home instead of ~/.codex

For users who set CODEX_HOME, or whose Codex home is auto-detected from Windows under WSL, the probe does not read ~/.codex: resolveCodexHomeDir() in src/codex/home.ts honors CODEX_HOME and can select a detected WSL home. This statement, together with the ~/.codex/AGENTS.md example above, directs those users to the wrong files; describe the location as $CODEX_HOME/the effective Codex home and identify ~/.codex only as the usual default.

AGENTS.md reference: docs-site/AGENTS.md:L7-L10

Useful? React with 👍 / 👎.

@lidge-jun

Copy link
Copy Markdown
Owner Author

리뷰 · 우선순위 48 / 80

설명

이 풀 리퀘스트는 프롬프트 레이어 패널 안내를 영어와 일곱 로케일에 넣습니다. 스택 맨 위입니다. 코드와 gui/ 는 건드리지 않습니다. 베이스는 #2681 입니다. 지금 current dev HEAD 37e5dd5ec 의 docs-site 사이드바에는 이 가이드가 없습니다.

본문은 스택이 무엇인지, 다섯 종류와 어느 것을 끌 수 있는지, 사용자 지정 레이어가 어디에 붙는지, 프리셋이 복사본이 아니라 각색인지, 새 세션에만 적용되는지를 적습니다. opencodex 가 Codex 가 합치는 여덟 설정 층 중 하나만 읽는다는 한계도 적습니다. 패널이 그 파일 값을 보여 주고, 해석이 끝난 Codex 설정 전체를 보여 주지 않는다고 말합니다.

devlog 070 은 영어와 네 로케일만 적었지만, 지금 astro.config.mjs 는 일곱 로케일을 쓰므로 일곱을 모두 넣었습니다. 한국어 문장은 번역투를 피하고 한 톤을 유지하려 했습니다. 사이드바 항목 Codex Prompt Layers 를 가이드 목록에 추가합니다.

초안이 아닙니다. 이 층만의 검사 결과는 성공 8, 건너뜀 8 입니다. 아래층 전체 스위트가 아니라 docs 빌드 쪽에 가깝습니다. mergeable_state 는 clean 입니다. 그래도 베이스가 빨간 스택 끝이라, 문서만 먼저 dev 에 올리면 아직 없는 UI 를 안내하게 됩니다.

문서가 아래층 동작에 묶여 있습니다. 프로브, 프리셋 다섯 개, 타이밍 규칙이 #2681·#2680 과 같은 말을 써야 합니다. 아래층이 바뀌면 이 문서도 같이 고쳐야 합니다. 코드 변경이 없으므로 types.ts/config.ts 분할과는 무관합니다. 미리보기 배포는 계획에 없습니다.

docs-site/astro.config.mjs - Codex Prompt Layers 사이드바 항목을 가이드에 추가합니다
docs-site/src/content/docs/ko/guides/codex-prompt.md - 한국어 안내가 패널·프로브·프리셋·한계를 같은 톤으로 적습니다
docs-site/src/content/docs/guides/codex-prompt.md - 영어 원본이 여덟 로케일의 기준입니다
경로/심볼 - 아래층 #2678-#2681 이 합쳐지기 전에 이 문서만 올리면 없는 UI 를 안내합니다
경로/심볼 - 코드 변경이 없어 런타임 회귀 위험은 없습니다

메인테이너의 판단이 필요한 지점

  • 문서만 먼저 올릴지, 스택 전체가 합쳐진 뒤에만 올릴지 정해야 합니다
  • 한국어 문장을 한 번 더 사람이 읽을지 정해야 합니다
  • 아래층이 프로브·프리셋 문구를 바꾸면 이 문서도 같이 고칠지 정해야 합니다

너의 추천

스택 코드 층이 합쳐진 뒤에 이 문서를 합치세요. 지금 혼자 올리지 마세요. 내용 방향은 맞습니다. 여덟 로케일을 한꺼번에 넣은 선택도 맞습니다. 미리보기 배포는 계획에 없습니다.

이 댓글은 grok-bot이 작성했습니다

@lidge-jun
lidge-jun force-pushed the codex/prompt-layers-realtext branch from c8de8a3 to 4ca216d Compare August 26, 2026 13:14
@lidge-jun
lidge-jun force-pushed the codex/prompt-layers-docs branch from 5d63efe to 8573545 Compare August 26, 2026 13:14
@lidge-jun
lidge-jun force-pushed the codex/prompt-layers-realtext branch from 4ca216d to 861a1ce Compare August 26, 2026 13:20
@lidge-jun
lidge-jun force-pushed the codex/prompt-layers-docs branch from 8573545 to 22c4854 Compare August 26, 2026 13:20
New guide plus its sidebar entry. devlog 070 asked for English and four
locales because astro.config.mjs declared four when it was written; the
site now carries seven, so all seven ship rather than leaving three in a
missing-translation state.
@lidge-jun
lidge-jun force-pushed the codex/prompt-layers-realtext branch from 861a1ce to cd71a1d Compare August 26, 2026 13:29
@lidge-jun
lidge-jun force-pushed the codex/prompt-layers-docs branch from 22c4854 to 5b1d6a9 Compare August 26, 2026 13:29
The stack went up green on my machine and came back red three times, each
time for the same reason: a layer that only builds on top of its
successors. CustomLayerDialog called three i18n keys whose catalog entries
lived a layer higher, so `tsc` failed at that tip and thirteen dependent
jobs followed it down - invisible from the stack head, which is the only
place I had been testing.

Also records the two real user-facing bugs the round surfaced (the layer
body that could only scroll sideways, and a failed probe reported as
measured truth), and the findings that were NOT ours so a later reader
does not chase pre-existing dev debt or a cancelled concurrency job.
MSGEOF && git log --oneline -1
Base automatically changed from codex/prompt-layers-realtext to dev August 26, 2026 14:39
@lidge-jun
lidge-jun changed the base branch from codex/prompt-layers-realtext to dev August 26, 2026 14:39
@lidge-jun
lidge-jun merged commit 94b5d94 into dev Aug 26, 2026
22 of 23 checks passed
@lidge-jun
lidge-jun deleted the codex/prompt-layers-docs branch August 26, 2026 14:39
tarunravi pushed a commit to tarunravi/opencodex that referenced this pull request Sep 14, 2026
…docs

docs(codex): document the prompt-layer panel in eight locales
agentHits pushed a commit to agentHits/opencodex that referenced this pull request Sep 17, 2026
…docs

docs(codex): document the prompt-layer panel in eight locales
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant