Repository navigation
docs(structure): split oversize docs and describe every source area - #5596
Conversation
Delete the root docs/ folder and the other PR evidence image folders (.github/pr-assets, assets/pr-screenshots, docs-site/public/pr-screenshots, loose assets/pr*.png). Move the GUI design-system contract and its ADR 0004/0005 to gui/design-system/, port the GitHub Copilot App client setup into docs-site guides/integrations.md, point every live reference at devlog/ or git history, declare docs/ in structure absentPaths, and guard the retired paths in repo-hygiene. Screenshots now go in the PR description or on the orphan pr-assets branch.
Carry the headless CLI parity rule, the doctor proxy-env disclosure rule and the CL-10 public-evidence closure contracts into structure/, state that sourceModels replaces the default shadow-call prefixes, explain the Copilot App API key on remote binds, and describe the screenshot gate by the gui/ paths it actually checks.
Split transports/responses.md, gui-and-management-api.md and providers/openai-tiers.md along heading boundaries so every structure doc fits the 600-line budget, rewriting cross-links to the doc that now owns each anchor. Describe src/bridge*, src/quota/, src/service-manager-probe.ts, src/sidecar/ and src/types/ in their owning docs. Both grace lists are now empty.
|
Navigate logical layers of code changes, visualize relationships, and explore their blast radius. Note Currently processing new changes in this PR. This may take a few minutes, please wait... ⚙️ Run configurationConfiguration used: Repository: lidge-jun/opencodex/.coderabbit.yaml Review profile: ASSERTIVE Plan: Advanced Run ID: 📒 Files selected for processing (46)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
github-actions
Bot
added
the
documentation
|
✅ Deterministic PR hygiene checks passed. |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 23ac89c59d
ℹ️ 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".
리뷰 · 우선순위 44 / 80이 PR은 이번 변경은 그 긴 문서를 이미 있던 제목 경계에서 잘라 새 문서로 옮겨요. Responses는 wire 모양·failover·spend로, GUI는 base는
메인테이너의 판단이 필요한 지점 #5593이 아직 열려 있어요. 이 PR을 #5593 머지 직후 너의 추천 알림 문장의 “written” 주장을 소스와 맞게 고친 뒤, #5593이 이 댓글은 grok-bot이 작성했습니다 |
✅ READY
Hygiene✅ Deterministic PR hygiene checks passed. |
|
Landed on
Full-platform CI runs on |
Summary
Stacked on #5593 (base
codex/remove-docs-pr-assets). Retarget todevafter #5593 lands.structure/manifest.jsoncarried two grace lists thatstructure/AGENTS.mdtreats as debt to pay down, not a place to park work. This PR empties both.Oversize docs split.
transports/responses.md(1507 lines, 2.5× the 600-line budget),gui-and-management-api.md(813) andproviders/openai-tiers.md(744) are split along existing heading boundaries into new docs:transports/responses-wire-shapes.mdtransports/responses-failover.mdtransports/responses-spend.mddashboard-and-usage.mdproviders/openai-accounts.mdText moves byte for byte. The only edit to moved text promotes a
###subsection to##where it became top level, and anchors are unchanged. A multiset comparison of non-blank lines shows 0 lost lines. 172 cross-links were rewritten to the doc that now owns each anchor. Fourteen decision records whose owning doc moved now point at it; the rest are untouched. The largest structure doc is now 600 lines.Every source area described. New sections name the six areas no doc covered:
src/bridge.ts,src/bridge/)src/quota/)src/service-manager-probe.ts)src/sidecar/)src/types/)Every sentence was checked against source.
One source comment (
src/lib/upstream-retry.ts) pointed at a moved anchor.Out of scope:
grace.unboundInvariants(INV-HOME-01, INV-SLUG-01) needs new tests rather than doc edits. Plan and review:devlog/_plan/260923_structure_tidy/.Verification
bun run structure:check: pass withgrace.oversizeDocsandgrace.undocumentedSourceAreasboth empty.structure/INDEX.mdwas regenerated withbun run structure:index.bun test tests/ci-workflows/structure-ssot.test.ts tests/ci-workflows/repo-hygiene.test.ts: 66 pass, 0 fail.bun run typecheck,bun run privacy:scan: pass.rg 'structure/' tests). The source diff is one comment line, so the full suite was not run locally; hosted CI covers it.gpt-6-solverifiers checked split fidelity and prose accuracy. Their four blockers (decision-record owners, manifest mapping, two overstatements) were fixed, and both re-verified PASS.Checklist
Summary by CodeRabbit