Skip to content

[WRONG BRANCH] docs: Fix link formatting for local dashboard URL - #4866

Closed
coding-ax wants to merge 1 commit into
lidge-jun:mainfrom
coding-ax:patch-1
Closed

coding-ax wants to merge 1 commit into
lidge-jun:mainfrom
coding-ax:patch-1

Conversation

@coding-ax

@coding-ax coding-ax commented Sep 17, 2026

Copy link
Copy Markdown

Update the link format for the local dashboard URL in the README.

Summary

  • Explain the user-visible or maintainer-facing change.

Verification

  • List the commands or checks you ran.
  • If this PR changes the GUI, include a screenshot of the UI change in the description.

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.

Review readiness checklist

This PR stays in draft until every box below is ticked. Tick all four boxes once the requirements are met:

  • All CI tests are green on my local testing.

  • I pushed my PR to the latest dev commit.

  • I resolved all correct Codex and CodeRabbit findings.

  • My PR is ready for review.

Summary by CodeRabbit

  • Documentation
    • Updated the Chinese quick-start guide so the dashboard URL in the personal installation section is displayed as a clickable link.

Update the link format for the local dashboard URL in the README.
@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 Sep 17, 2026
@github-actions github-actions Bot changed the title docs: Fix link formatting for local dashboard URL [WRONG BRANCH] docs: Fix link formatting for local dashboard URL Sep 17, 2026
@coderabbitai

coderabbitai Bot commented Sep 17, 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: 2e44ba13-301b-47db-8d90-88990407e914

📥 Commits

Reviewing files that changed from the base of the PR and between 44de45d and fcef614.

📒 Files selected for processing (1)
  • readme/README.zh-CN.md

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


📝 Walkthrough

Walkthrough

The Chinese README now renders http://localhost:10100 as a clickable Markdown hyperlink in the personal installation quick-start section.

Changes

Dashboard link

Layer / File(s) Summary
README dashboard link
readme/README.zh-CN.md
Line 89 wraps http://localhost:10100 in Markdown link syntax.

Priority: ⬇️ Low

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

Change: Other

Merge Risk: ⚪ Minimal · up to fcef6

The README now makes the existing local dashboard URL clickable without changing its destination or runtime behavior.

🚥 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 accurately describes the README change: it fixes the link formatting for the local dashboard URL. The [WRONG BRANCH] prefix is extra metadata, but it does not make the title misleading.
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 💡 1
🛠️ Fix failing CI checks 💡
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Warning

⚠️ This pull request shows signs of AI-generated slop (ai_padded_prose). It has been flagged by CodeRabbit slop detection and should be reviewed carefully.


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 17, 2026

Copy link
Copy Markdown
Contributor

⏳ DRAFT

  • wrong target branch (main); retarget to dev.

What to do

  • Retarget this PR to dev — all contributions go to dev.
  • Tick all four boxes in the PR description once you're done (currently 0/4).

Review readiness checklist

  • ⬜ All CI tests are green on my local testing.
  • ⬜ I pushed my PR to the latest dev commit.
  • ⬜ I resolved all correct Codex and CodeRabbit findings.
  • ⬜ My PR is ready for review.

0/4 boxes ticked.

Its title has been prefixed with [WRONG BRANCH].
This pull request was already a draft. Its draft status will be preserved after every issue above is resolved.
@coding-ax Tick the boxes once your local CI is green, your branch is on the latest dev commit, and every correct Codex and CodeRabbit finding is resolved.

@github-actions
github-actions Bot marked this pull request as draft September 17, 2026 06:08
@lidge-jun

Copy link
Copy Markdown
Owner

리뷰 · 우선순위 58 / 80

이 PR은 coding-ax가 readme/README.zh-CN.md 한 줄만 고친 문서 수정이다. 현재 dev HEAD(e18ca2463, tip #4862 config show connect-graph 수입 제거)와 비교하면 코드·설정·테스트는 전혀 건드리지 않고, 간체 중국어 README의 로컬 대시보드 안내 문장만 바꾼다. 지금 dev/main 모두 打开 **http://localhost:10100**,在 Web 仪表板中完成所有配置처럼 URL을 굵은 글씨만 씌운 형태인데, 이 PR은 그걸 打开 **[http://localhost:10100](http://localhost:10100)**,…처럼 Markdown 명시 링크로 바꿔서, 일부 렌더러·미리보기에서 클릭 가능한 링크로 보이게 하려는 의도다. 변경량은 +1/−1이고 대상 파일도 하나뿐이라 범위는 아주 작다.

다만 게이트 봇이 이미 표시했듯이 이 PR의 base는 main이다. opencodex 기여는 전부 dev로 들어와야 하고, 지금 제목도 [WRONG BRANCH]로 붙어 Draft로 잠겨 있다. 또 dev의 루트 README.mdreadme/README.{ko,ja,zh-TW,fr,ru,tr}.md는 전부 같은 위치에서 여전히 **http://localhost:10100** 형태다. 이 저장소에는 아직 [http://localhost:10100](http://localhost:10100) 패턴이 한 곳도 없어서, 간체만 먼저 바꾸면 로케일 간 안내 형식이 어긋난다. PR 본문 Summary/Verification도 템플릿 그대로라 왜 zh-CN만인지, 전 로케일 통일인지가 설명되어 있지 않다.

실질 위험은 거의 없다. URL 자체(http://localhost:10100)와 문장 의미는 같고, types.ts/config.ts 분리 캠페인과도 무관하다. 다만 ‘문서 클릭성 개선’을 진짜로 받아들이려면 같은 문단을 쓰는 다른 README에도 같은 패턴을 맞추는 편이 맞고, 반대로 zh-CN만 허용할 거면 메인테이너가 그 방침을 한 줄로 밝혀야 한다. 지금 상태로는 머지 대상도 틀렸고 로케일 범위도 반쪽이라 Ready로 올리기 전에 정리할 일이 남아 있다.

우선순위 58/80으로 둔 이유: 고치는 방향(명시 링크)은 맞고 해롭지도 않지만, wrong-branch + 단일 로케일 + 빈 설명 때문에 즉시 랜딩 후보는 아니다. 문서 마이크로픽스치고는 점수를 너무 낮추지 않았고, 동시에 게이트가 이미 Draft로 막아 둔 상태를 존중한다.

참고로 같은 시각에 dev tip은 여전히 #4862 perf(cli) 랜딩 이후이고 패키지는 2.58.0이다. 이 PR은 그 방향과 충돌하지 않으며, 다만 문서 하우스 스타일(볼드 URL vs 명시 링크)을 언제 통일할지 한 번만 정해 두면 이후 비슷한 로케일 PR이 반복되지 않는다.

라인 89 - readme/README.zh-CN.md에서만 **http://…****[http://…](http://…)**로 바뀜. 클릭성 개선 자체는 맞지만, 루트 README·다른 로케일 README는 전부 예전 형식이라 로케일 드리프트가 생김.
경로/baseRefName - base가 main이다. 기여는 dev로 들어와야 하며, 게이트가 이미 [WRONG BRANCH] + Draft로 잠근 상태다.
경로/PR body - Summary·Verification·체크리스트가 템플릿 그대로(0/4). 왜 zh-CN만인지, 로컬에서 어떤 렌더러로 확인했는지 없음.
경로/심볼 - dev 전체에서 [http://localhost:10100](…) 패턴이 아직 0건. 이 PR이 새 하우스 스타일을 도입하는 첫 변경이면 전 로케일 묶음이 맞고, 아니면 zh-CN-only를 명시해야 함.

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

  • 로컬 대시보드 URL을 전 로케일에서 Markdown 명시 링크로 통일할지, 아니면 볼드 URL을 유지할지.
  • zh-CN만 먼저 받아줄지, 아니면 같은 패치로 README.md + readme/*.md를 한 PR에 묶을지.
  • wrong-branch Draft를 retarget 후 유지할지, 닫고 dev 대상 새 PR로 다시 받을지.

너의 추천
KEEP Draft. base를 dev로 바꾸고(또는 dev 대상 새 PR로 재제출), 같은 문단을 쓰는 루트 README와 다른 로케일 README에도 동일 링크 형식을 맞추거나, zh-CN-only를 본문에 한 줄로 명시하라. types/config 분리와 무관하니 close-don't-rebase 대상은 아니다. 설명·체크리스트를 채운 뒤에만 Ready로 올린다.

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

@lidge-jun

Copy link
Copy Markdown
Owner

Thank you for spotting this — the bare http://localhost:10100 really should be a link. Closing this one and asking for a re-open against dev, for two reasons.

The first is the base branch: pull requests here target dev, and main only moves by maintainer promotion.

The second is more substantive. The bare form is not a zh-CN oversight — it is what all seven locales and the English README.md do. Applying this change alone would leave zh-CN as the only file using link syntax, which is exactly the "translated locale contradicts the English source" case our review guidelines ask us to catch. The version worth merging changes all eight files together.

If you would like to open that, it would be welcome.

@lidge-jun lidge-jun closed this Sep 17, 2026
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.

2 participants