Skip to content

docs: complete Raycast status and model-name recovery guidance - #3883

Merged
lidge-jun merged 1 commit into
devfrom
codex/260907-e-docs-followups
Sep 7, 2026
Merged

lidge-jun merged 1 commit into
devfrom
codex/260907-e-docs-followups

Conversation

@lidge-jun

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

Copy link
Copy Markdown
Owner

Summary

  • Qualify Raycast CLI setup advice for macOS/Windows while preserving the literal aiDirPresent filesystem contract and raw JSON output. Add direct text/JSON assertions for pro/free/unknown plans with the directory present or missing.
  • Complete display-name editor and recovery guidance in seven provider reference locales, and remove ZCode, Prime Agent and Aside only from the French comment-capable full-rewrite examples. Existing Copilot and modelCosts content is preserved.

Verification

  • Current manual chain: docs: complete Raycast status and model-name recovery guidance #3883 head e0a1a8836e447ece3010ba98813e6feb3161eefddocs: record code-mode delivery and qualify Desktop model switching #3884 top f8c8f6dd15b1518f25a3b1cd7b15c9b6c8b24f62, based on dev@f4a4b468feb04094b90c909d82e04606caf92663.
  • Central Cross-platform CI on the top: run 34121907231, lane=all, all 16 required per-chain jobs SUCCESS at the exact top (attempt 1). The lower layer has no separate suite dispatch. Prior run 34120282456 was cancelled after scheduling instructions crossed and is not evidence.
  • Required per-chain checks: Linux 4 shards, macOS 2 shards, gates/storage/api/keyring/npm/docker. Windows 6 shards and macOS control are excluded under the owner-approved per-chain policy and reserved for final train validation.
  • Independent Astra source audit (Tesla): PASS, no corrections, at the exact base/lower/top above. Layer patches and six Desktop locale replacements match reviewed content. C's seven code-mode translations are already present and semantically consistent in the pinned base.
  • Per main instruction after D landed, merge-tree against dev@da707ccb6 is conflict-free, expected tree c415b6abd77d5f05148fa2a114116d4b492177e0. It includes D changes and therefore differs from tested top tree 986ae11d785934bb4e118a869d38532c1365863d; no combined-tree test claim is made.
  • Local suite, typecheck, build, install and privacy scan: NOT RUN by instruction. Source diff/applicability checks passed; they do not establish a documentation build or runtime pass. Required-head CI passed. CodeRabbit review after ready-for-review and current policy refresh remain to be checked.

Manual chain (stack: null; merge bottom-up):

Layer PR / branch Base Scope
1 this PR / codex/260907-e-docs-followups dev Raycast and locale followups
2 #3884 / codex/260907-e-code-mode-docs codex/260907-e-docs-followups Delivery record and Desktop model-switch qualification; CI top

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 (no auth, credential, transport or workflow changes).

Summary by CodeRabbit

  • Documentation

    • Added multilingual guidance for editing and resetting model display names in the dashboard, including routing-alias distinctions, retry behavior, and timeout handling.
    • Clarified Raycast support for macOS and Windows, with Linux unsupported, and documented status fields, setup guidance, and JSON output.
    • Updated French integration documentation to accurately identify supported comment-capable formats.
  • Bug Fixes

    • Improved Raycast CLI guidance when the providers configuration folder is missing, including platform-specific setup instructions.

@coderabbitai

coderabbitai Bot commented Sep 7, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Team

Run ID: 60e9c091-f721-4028-89a0-12c383874e10

📥 Commits

Reviewing files that changed from the base of the PR and between f4a4b46 and e0a1a88.

📒 Files selected for processing (11)
  • docs-site/src/content/docs/fr/guides/integrations.md
  • docs-site/src/content/docs/fr/reference/configuration/providers.md
  • docs-site/src/content/docs/guides/integrations.md
  • docs-site/src/content/docs/ja/reference/configuration/providers.md
  • docs-site/src/content/docs/ko/reference/configuration/providers.md
  • docs-site/src/content/docs/ru/reference/configuration/providers.md
  • docs-site/src/content/docs/tr/reference/configuration/providers.md
  • docs-site/src/content/docs/zh-cn/reference/configuration/providers.md
  • docs-site/src/content/docs/zh-tw/reference/configuration/providers.md
  • src/cli/integrations.ts
  • tests/cli/cli-headless-parity.test.ts

📝 Walkthrough

Walkthrough

The PR updates localized provider documentation, clarifies Raycast platform and status behavior, expands CLI guidance, adds parity coverage, and corrects a French integration-format list.

Changes

Documentation and Raycast status

Layer / File(s) Summary
Raycast status guidance and parity
docs-site/src/content/docs/guides/integrations.md, src/cli/integrations.ts, tests/cli/cli-headless-parity.test.ts
Documents macOS and Windows support, the aiDirPresent signal, and platform-scoped setup guidance. Tests cover human and JSON output for all plan and directory-status combinations.
Localized model display-name documentation
docs-site/src/content/docs/{fr,ja,ko,ru,tr,zh-cn,zh-tw}/reference/configuration/providers.md
Documents display-name editing, reset behavior, routing-selector separation, retry handling, and the 60-second write and refresh timeout.
French integration list correction
docs-site/src/content/docs/fr/guides/integrations.md
Removes ZCode, Prime Agent, and Aside from the full comment-rewriting client list.

Estimated code review effort: 2 (Simple) | ~10 minutes

Suggested reviewers: invalid-email-address

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex/260907-e-docs-followups

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

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 7, 2026
@lidge-jun

Copy link
Copy Markdown
Owner Author

리뷰 · 우선순위 52 / 80

이 PR은 dev HEAD d00615d56 위의 문서·CLI 후속입니다. 지금 dev의 Raycast 안내(docs-site/.../guides/integrations.md)는 Pro 플랜과 Reveal Providers Configai 폴더를 만들라는 설명까지는 있지만, 지원 OS를 분명히 가르지 않습니다. 상태 필드 aiDirPresent가 “폴더만 있다”는 뜻인지, “Raycast가 설치·사용 가능하다”는 뜻인지도 헷갈릴 수 있습니다. CLI 쪽(src/cli/integrations.tssingleClientStatusLines)도 폴더가 없을 때 같은 Reveal 안내를 한 줄로 찍고, plan은 별도 줄로 냅니다. 이 PR은 그 안내를 macOS와 Windows만 지원한다고 못 박고, Linux는 폴더가 있어도 미지원이라고 적습니다. 또 aiDirPresent는 경로 존재만 보고, 앱 설치·지원 여부의 증거가 아니라고 풀어 줍니다. CLI 안내 문장에도 “On macOS or Windows,”를 앞에 붙여 문서와 같은 경계를 맞춥니다.

표시 이름 편집기 안내도 같이 채웁니다. 영어 본문(docs-site/.../reference/configuration/providers.md)에는 이미 Discoverd model display names / 대시보드 Name·Reset name·Retry·60초 제한 설명이 있습니다. 이 PR은 fr/ja/ko/ru/tr/zh-cn/zh-tw 로케일 providers 참고서에 같은 절을 넣고, 프랑스어 integrations 전체 재작성 예시 목록에서 ZCode·Prime Agent·Aside만 빼서 영어 쪽(이미 Hermes…Raycast 목록)과 맞춥니다. Copilot·modelCosts 본문은 건드리지 않습니다.

테스트는 tests/cli/cli-headless-parity.test.ts에 plan×aiDirPresent 6조합을 넣습니다. 사람 읽기 출력에서 plan: 한 줄이 플랜 값과 같고, 폴더가 없을 때만 macOS/Windows Reveal 안내가 나오며, --json은 원본 payload를 그대로 두고 안내 문구를 섞지 않는지 확인합니다. types.ts/config.ts 대분할과 겹치지 않는 문서·CLI 문자열·헤드리스 패리티 테스트 범위입니다. 드래프트이고 커밋에 [skip ci]가 있으니, 체인 맨 위(#3884)에서 중앙 lane=all을 돌리기 전까지는 LANDABLE로 보지 않는 게 맞습니다. 런타임 Raycast 설치 경로를 바꾸지 않고, 사용자가 이미 겪는 “폴더는 있는데 Linux라서 안 된다 / plan과 설치 신호가 섞인다” 혼란을 글로 줄이는 값입니다.

docs-site/.../guides/integrations.md Raycast 절 - macOS/Windows 지원·Linux 미지원·aiDirPresent 의미를 분리해 문서 계약을 고칩니다.
src/cli/integrations.ts 약 192줄 - Reveal 안내에 OS 한정 문구를 넣어 문서와 CLI를 같게 만듭니다.
tests/cli/cli-headless-parity.test.ts - plan pro/free/unknown × aiDirPresent true/false. 텍스트와 JSON 경로를 둘 다 잠급니다.
로케일 providers.md (fr/ja/ko/ru/tr/zh-cn/zh-tw) - 표시 이름 편집기 UI 안내를 영어와 맞춥니다. 설정 스키마(modelDisplayNames) 절과는 다른 “대시보드 Name 버튼” 절입니다.
docs-site/.../fr/guides/integrations.md - 전체 재작성 클라이언트 목록에서 ZCode·Prime Agent·Aside 제거. 영어 본문과 맞춤.

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

  • 드래프트를 ready로 올릴지, #3884와 묶은 문서 체인으로만 머지할지
  • Linux에서 ~/.config/raycast/ai가 있어도 제품이 정말 쓰기를 거절하는지(문서 주장과 코드 거부 경로가 같은지) 한 번만 확인할지
  • 로케일 표시 이름 절이 영어의 Name/Retry 문장과 의미 동등한지(번역 QA) 별도 패스로 볼지
  • 이 레이어만 먼저 dev에 넣고 #3884를 리베이스할지, 체인 통째로 올릴지

너의 추천
드래프트 유지한 채 #3884와 함께 문서 체인으로 보세요. 내용 자체는 dev 방향(Raycast 관리형 연동·표시 이름)과 맞고 위험이 작습니다. ready로 바꾼 뒤 체인 정상 CI가 초록이면 #3883#3884 순으로 머지하세요. types/config 분할과 무관하니 닫지 마세요.

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

@lidge-jun
lidge-jun force-pushed the codex/260907-e-docs-followups branch 2 times, most recently from 3ee30e8 to 403acd2 Compare September 7, 2026 11:55
@lidge-jun
lidge-jun force-pushed the codex/260907-e-docs-followups branch from 403acd2 to e0a1a88 Compare September 7, 2026 12:08
@lidge-jun
lidge-jun marked this pull request as ready for review September 7, 2026 12:37
@lidge-jun
lidge-jun requested a review from Ingwannu as a code owner September 7, 2026 12:37
@lidge-jun
lidge-jun merged commit 1649247 into dev Sep 7, 2026
11 of 14 checks passed
@lidge-jun
lidge-jun deleted the codex/260907-e-docs-followups branch September 7, 2026 12:37
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Sep 7, 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-07T12:39:28.241390Z e0a1a88 Draft marked ready
ℹ️ 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.

agentHits pushed a commit to agentHits/opencodex that referenced this pull request Sep 17, 2026
…st copy, CLI text tests, locale editor sections, French fix) [skip ci]

docs: complete Raycast status and model-name recovery guidance
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