Skip to content

[WRONG BRANCH] docs(cli): clarify platform-specific service repair behavior - #490

Draft
luvs01 wants to merge 1 commit into
mainfrom
codex/fix-documentation-for-service-repair-behavior
Draft

[WRONG BRANCH] docs(cli): clarify platform-specific service repair behavior#490
luvs01 wants to merge 1 commit into
mainfrom
codex/fix-documentation-for-service-repair-behavior

Conversation

@luvs01

@luvs01 luvs01 commented Sep 12, 2026

Copy link
Copy Markdown
Owner

Motivation

  • The lifecycle reference incorrectly implied that ocx service repair performs a no-op reload on all platforms, but the implementation only avoids a restart on macOS; Linux and Windows still restart the service.
  • This misleading cross-platform wording could cause operators to run repair expecting no interruption on Linux/Windows and experience an unexpected restart.

Description

  • Update the English docs-site/src/content/docs/reference/cli/lifecycle.md to scope the no-op repair behavior to macOS, state that Linux and Windows restart the service, and make the version-skew advice macOS-specific.
  • Apply the same platform-specific wording to the Korean lifecycle reference at docs-site/src/content/docs/ko/reference/cli/lifecycle.md.
  • No runtime code or tests in src/ were modified; this change is documentation-only and keeps Windows re-registration behavior described as conditional.

Testing

  • Built the docs site with cd docs-site && bun install --frozen-lockfile && bun run build, which completed successfully and produced 425 pages.
  • Ran the repository privacy check with bun run privacy:scan, which passed.
  • Ran git diff --check as a validation step to ensure no trailing whitespace or diff-check issues; it reported clean results.

Codex Task

@coderabbitai

coderabbitai Bot commented Sep 12, 2026

Copy link
Copy Markdown

Important

  • 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Advanced

Run ID: 8ad1c5cb-0a1a-4f0d-a82c-bd5edaf5d295


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.

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Sep 12, 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-12T01:56:12.330779Z d465f85 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.

@github-actions

Copy link
Copy Markdown

Deterministic PR hygiene checks passed.

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Sep 12, 2026
@github-actions

github-actions Bot commented Sep 12, 2026

Copy link
Copy Markdown

⏳ DRAFT

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

What to do

  • Retarget this PR to dev — all contributions go to dev.

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.

@github-actions github-actions Bot changed the title docs(cli): clarify platform-specific service repair behavior [WRONG BRANCH] docs(cli): clarify platform-specific service repair behavior Sep 12, 2026
@github-actions
github-actions Bot marked this pull request as draft September 12, 2026 01:54

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: d465f85752

ℹ️ 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".

Comment on lines +323 to +324
| `repair` | Refresh an installed service in place. On macOS, the manager is reloaded only when something changed, so a healthy, unchanged job keeps running and the repair is not an outage. On Linux and Windows, the service is restarted; a healthy Windows scheduler definition is reused, while a stale definition may be re-registered and require elevation. |
| `restart` | The same refresh and a guaranteed restart on every platform. On macOS an unchanged, already-loaded job is kickstarted in place. Not an alias of `repair`. |

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Update every translated lifecycle table

This platform-specific correction was applied only to English and Korean, while the French, Japanese, Russian, Turkish, Simplified Chinese, and Traditional Chinese lifecycle tables still state that repair always restarts the service and that restart is its alias. On macOS, readers of those pages can therefore run repair after an upgrade expecting a restart and leave the old process serving; update the corresponding translated tables and version-skew guidance to match the new canonical behavior.

AGENTS.md reference: docs-site/AGENTS.md:L7-L10

Useful? React with 👍 / 👎.

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

Labels

aardvark codex documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant