Skip to content

docs(contributing): replace removed postmerge script with build:gui - #5821

Merged
lidge-jun merged 1 commit into
devfrom
codex/contributing-postmerge-doc
Sep 25, 2026
Merged

lidge-jun merged 1 commit into
devfrom
codex/contributing-postmerge-doc

Conversation

@lidge-jun

@lidge-jun lidge-jun commented Sep 25, 2026 •

Copy link
Copy Markdown
Owner

Summary

#5771 retired the managed post-merge hook and removed the postmerge package script, but the English contributing guide still tells contributors to run bun run postmerge after a merge that changes gui/. That command now fails with "Script not found". This change points them at bun run build:gui, which is the command that actually rebuilds gui/dist. The translated guides never mentioned postmerge, so only the English page changes.

Verification

  • rg -n postmerge package.json docs-site CONTRIBUTING.md finds no remaining reference to the removed script (only historical devlog/ notes mention it).
  • package.json on dev defines build:gui and no postmerge script.
  • Docs-only change; no runtime or test code touched.

Checklist

  • Targets dev
  • Docs-only; English source updated, translations already consistent
  • No generated files or screenshots committed

Summary by CodeRabbit

  • Documentation
    • Updated the contributing guide to instruct contributors to run bun run build:gui after merges that change gui/. The note about the dev server rebuilding on demand remains.

@lidge-jun
lidge-jun requested a review from Ingwannu as a code owner September 25, 2026 04:53
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Sep 25, 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-25T04:55:28.574133Z 684f896 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 25, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

Important

Review skipped

Review was skipped as selected files did not have any reviewable changes.

⚙️ Run configuration

Configuration used: Repository: lidge-jun/opencodex/.coderabbit.yaml

Review profile: ASSERTIVE

Plan: Advanced

Run ID: d8e031db-f528-4987-94ab-5bc4f61ac501

📥 Commits

Reviewing files that changed from the base of the PR and between 684f896 and c10d06f.

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

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository: lidge-jun/opencodex/.coderabbit.yaml

Review profile: ASSERTIVE

Plan: Advanced

Run ID: c388bf74-8e20-41b8-8889-1cd537659c4f

📥 Commits

Reviewing files that changed from the base of the PR and between 6549056 and 684f896.

📒 Files selected for processing (1)
  • docs-site/src/content/docs/contributing.md

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


📝 Walkthrough

Walkthrough

The contributing guide now directs contributors to run bun run build:gui after a merge changes gui/. It retains the note that the dev server rebuilds on demand.

Changes

Contributor GUI build guide

Layer / File(s) Summary
Update the GUI build instruction
docs-site/src/content/docs/contributing.md
The guide replaces bun run postmerge with bun run build:gui for rebuilding the packaged dashboard after a merge that changes gui/. It retains the note about on-demand dev server rebuilds.

Priority: ⬇️ Low

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

Change: Other

Merge Risk: ⚪ Minimal · up to 684f8

The guide now points contributors to the command that builds and prepares the packaged dashboard. No merge-blocking risk is evident.

Architecture Summary

Architecture risk: 🔵 Low · up to 684f8

The change affects 1 system.

Changed systems: docs-site

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

  • observed — docs-site (service) was modified; 1 changed file maps to changed impact.

Before / after behavior

  • observed — Modified behavior in docs-site/src/content/docs/contributing.md: The guide replaces bun run postmerge with bun run build:gui as the command to rebuild the packaged dashboard after a merge that changes gui/; it still notes that the dev server rebuilds on demand.
🚥 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 and concisely describes the documentation change: replacing the removed bun run postmerge command with bun run build:gui in the contributing guide.
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)
  • Commit to this branch
  • Create a new PR

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 added the documentation Improvements or additions to documentation label Sep 25, 2026
@lidge-jun

Copy link
Copy Markdown
Owner Author

리뷰 · 우선순위 18 / 80

이 PR은 기여 안내 영어 문서에서 없어진 명령을 지운다. 바탕 브랜치는 dev다.

머지가 끝나면 대시보드 묶음 파일(gui/dist)을 다시 만들던 post-merge 훅이 있었다. #5771이 그 훅과 package.json의 postmerge 스크립트를 뺐다. 문서 사이트 영어 페이지는 그 뒤로도 bun run postmerge를 실행하라고 적고 있었다. 지금 그 명령을 치면 스크립트를 찾을 수 없다고 나온다.

바뀐 문장은 bun run build:gui만 실행하라고 한다. 이 커밋의 package.json에는 build:gui가 있고 postmerge 키는 없다. build:gui는 gui를 빌드하고 패키지를 준비해서, GET /로 나가는 대시보드를 새로 만든다. 개발용 서버(bun run dev:gui)는 필요할 때 스스로 다시 그린다. 직접 빌드가 필요한 쪽은 묶음 대시보드다. 저장소 맨 위 CONTRIBUTING.md도 이미 bun run build:gui라고 적혀 있다. 실행 코드와 테스트는 그대로다.

라인 - docs-site/src/content/docs/contributing.md 30행. 없는 bun run postmerge를 뺀 내용은 맞다. 한국어·일본어·중국어(간체/번체)·프랑스어·러시아어·터키어 페이지에는 bun run postmerge라는 글자가 원래 없다. 그 페이지들은 "gui가 바뀐 머지 뒤에는 bun run build:gui를 직접 실행하라"는 문장도 없다. 훅을 걷어 낸다는 설명과, 묶음 대시보드는 build:gui로 만든다는 설명만 있다.

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

다른 언어 문서에 같은 한 문장을 넣을지 정하면 된다. 깨진 명령은 영어 페이지에만 있었으므로, 이 PR만 머지해도 그 오류 안내는 사라진다.

이 변경은 types.ts와 config.ts를 나누는 작업이 아니다. 무효이거나 중복이라 닫을 대상도 아니다.

너의 추천

그대로 머지하면 된다. 번역 문장을 맞추는 일은 이번 PR 밖으로 둬도 된다.

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

@github-actions

Copy link
Copy Markdown
Contributor

✅ Deterministic PR hygiene checks passed.

@lidge-jun
lidge-jun force-pushed the codex/contributing-postmerge-doc branch from 684f896 to c10d06f Compare September 25, 2026 05:35
@lidge-jun
lidge-jun merged commit 6fbab23 into dev Sep 25, 2026
24 checks passed
@lidge-jun
lidge-jun deleted the codex/contributing-postmerge-doc branch September 25, 2026 05:58
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