Skip to content

devlog: name the language on the design-dial fence - #4098

Merged
lidge-jun merged 1 commit into
devfrom
codex/usage-range-devlog-fence
Sep 9, 2026
Merged

devlog: name the language on the design-dial fence#4098
lidge-jun merged 1 commit into
devfrom
codex/usage-range-devlog-fence

Conversation

@lidge-jun

@lidge-jun lidge-jun commented Sep 9, 2026

Copy link
Copy Markdown
Owner

Summary

Verification

  • One-character-class docs change with no code path: no test covers a devlog fence, and the repository gates (hygiene, enforce-target, gates) run on this head.
  • Local suite runs are disallowed for this task by the maintainer, so bun run test is NOT RUN locally; remote CI on this head is the evidence.

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.

Summary by CodeRabbit

  • Documentation
    • Improved syntax highlighting for a Design read section code block by identifying it as plain text.

CodeRabbit flagged MD040 on the dial block in the usage custom-range plan unit.
It is plain configuration-style text, so the fence says so.
@lidge-jun
lidge-jun requested a review from Ingwannu as a code owner September 9, 2026 08:07
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Sep 9, 2026

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review Completed 2026-09-09T08:09:26.370169Z e545d0e PR opened
ℹ️ 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" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@coderabbitai

coderabbitai Bot commented Sep 9, 2026

Copy link
Copy Markdown
Contributor

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Advanced

Run ID: 2dbb1b25-7173-4b45-a87d-aac2f8803a25

📥 Commits

Reviewing files that changed from the base of the PR and between 52ad823 and e545d0e.

📒 Files selected for processing (1)
  • devlog/_plan/260909_usage_custom_range_disclosure/000_plan.md

Included review availability: Your plan provides up to 10 included reviews per hour; 1 remains after this review.


📝 Walkthrough

Walkthrough

The plan updates the Design read section to mark its fenced block as plain text.

Changes

Plan documentation

Layer / File(s) Summary
Plain text fence annotation
devlog/_plan/260909_usage_custom_range_disclosure/000_plan.md
Line 13 changes the opening code fence from ``` to ```text.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~2 minutes

Merge Risk: ⚪ Minimal · up to e545d

This documentation-only change labels an existing design block as plain text without changing its content or runtime behavior. No current merge-readiness risk remains.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly describes the documentation change: adding a language identifier to the design-dial code fence in the devlog plan. It is concise and directly related to the pull request objective.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex/usage-range-devlog-fence

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

github-actions Bot commented Sep 9, 2026

Copy link
Copy Markdown
Contributor

Deterministic PR hygiene checks passed.

@lidge-jun

Copy link
Copy Markdown
Owner Author

Maintainer integration record

Docs-only follow-up to #4093, integrated into dev under the dev-only maintainer bypass in MAINTAINERS.md (admin access, own pull request). Not a self-approval and not an independent review.

Exact head: e545d0e69914deaf9c8c8443185d7ba49e83263e

Verification on that head: enforce-target, hygiene, label, resolve-pr, changes, ci, select windows runner, react-doctor and CodeRabbit all pass. The Cross-platform product jobs report as skipping because the workflow's path filter excludes a change that touches only devlog/ — a structural skip, not a waived gate. bun run test is NOT RUN locally per the maintainer instruction on this task.

@lidge-jun
lidge-jun merged commit 0480891 into dev Sep 9, 2026
23 checks passed
@lidge-jun
lidge-jun deleted the codex/usage-range-devlog-fence branch September 9, 2026 08:11
@lidge-jun

Copy link
Copy Markdown
Owner Author

리뷰 · 우선순위 44 / 80

이 PR은 #4093이 dev에 올린 Usage 커스텀 날짜 범위 계획 문서 devlog/_plan/260909_usage_custom_range_disclosure/000_plan.md 안의 Design read 코드 펜스에 언어 태그를 붙입니다. 지금 dev HEAD(52ad82319)에는 그 파일이 이미 있고, 13번 줄 근처 DESIGN_VARIANCE / MOTION_INTENSITY / Product density profile 블록이 언어 이름 없는 펜스로 열려 있습니다. CodeRabbit이 MD040(fenced code language)을 그 블록에 걸었고, 내용은 설정 스타일 평문이므로 여는 펜스에 text 태그를 넣습니다. 추가·삭제 각 1줄이고 소스·테스트·워크플로·로케일은 건드리지 않습니다. 제품 방향(2.49 백로그, 프록시/할당량, OrcaRouter 스폰서 표면)과는 무관한 문서 위생 수정입니다. types.ts/config.ts 분할과도 무관하고, 중복 PR도 아닙니다.

설명하자면, markdownlint MD040은 펜스에 언어 이름을 요구합니다. 언어를 안 쓰면 하이라이터가 추측하거나 린트가 경고합니다. 이 블록은 TypeScript도 JSON도 아니고, 디자인 다이얼 값을 사람이 읽게 적은 평문입니다. text는 “문법 하이라이트 하지 말고 그대로 보여 줘”라는 뜻이라 내용과 맞습니다. #4093 본문은 이미 머지됐고, 이 PR은 그 계획 유닛의 린트만 따라잡는 후속입니다. 로컬 bun run test는 작성자가 의도적으로 생략했고, remote hygiene / enforce-target / changes가 이 헤드에서 통과한 상태입니다. 같은 폴더의 다른 md는 이번 diff에 없고, GUI Usage disclosure 본체(gui/src/pages/Usage.tsx)는 이미 #4093으로 dev에 들어가 있습니다.

라인 13 - 언어 없는 여는 펜스에 text를 붙입니다. MD040을 끄고 내용을 평문으로 표시합니다.
경로 범위 - 000_plan.md 한 파일만 바꿉니다. GUI·런타임·게이트 스크립트는 그대로입니다.
경로 CI - docs-only라 테스트 매트릭스는 skip이 정상입니다. 이미 통과한 hygiene/enforce-target이 권위입니다.
경로 형제 문서 - 같은 폴더의 다른 md에 언어 없는 펜스가 더 있는지는 이번 diff 밖입니다. 필요하면 별도 청소 PR로 묶는 편이 낫습니다.
경로 #4093 관계 - 기능은 이미 52ad82319에 있고, 이 PR은 계획 문서 표시만 고칩니다. 기능 회귀 위험은 사실상 없습니다.

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

  • 계획 유닛 린트를 usage: open the custom date range on request instead of on arrival #4093 직후 바로 넣을지, 다음 docs 묶음에 모을지
  • 저장소 전역으로 언어 없는 펜스(MD040)를 한 번에 청소할지, 이번에 걸린 한 곳만 고칠지
  • text 대신 plaintext/conf 같은 별칭을 쓸지(동작은 거의 같고 팀 관례만 다름)

너의 추천
바로 머지하세요. 한 줄 docs 수정이고 CI hygiene이 이미 초록입니다. 기능 코드와 무관하니 백로그 열차에 끼울 필요도 없습니다. 같은 폴더에 언어 없는 펜스가 더 보이면 그때 작은 청소 PR로 묶으면 됩니다.

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant