docs: Clarify that clp-config.yaml changes require a full service restart (resolves #1795).

[junhaoliao]

Description

Extend the existing "Note" admonition in both quick-start guides (clp-text and clp-json) to clarify that changes to etc/clp-config.yaml are not hot-reloaded and require a full sbin/stop-clp.sh / sbin/start-clp.sh cycle to take effect.

The restart clarification is added as a bullet point in the existing Note (which already references etc/clp-config.yaml for port conflicts) rather than as a separate admonition, to reduce visual
clutter in the "Starting CLP" section.

Checklist

• The PR satisfies the contribution guidelines.
• This is a breaking change and that has been indicated in the PR title, OR this isn't a
  breaking change.
• Necessary docs have been updated, OR no docs need to be updated.

Validation performed

0. Build docs

Task: Verify the docs build successfully.

Command:

task docs:site

Output:

build succeeded.

The HTML pages are in ../build/docs/html.

1. Verify clp-json quick-start page

Served the docs locally and opened the clp-json quick-start page in a browser. The "Note" admonition under "Starting CLP" contains two bullet points: one for port-conflict troubleshooting and one clarifying that configuration changes are not hot-reloaded.

2. Verify clp-text quick-start page

Navigated to the clp-text quick-start page. The same merged "Note" admonition is present with identical content.

Summary by CodeRabbit

Documentation

• Clarified startup and configuration procedures in quick-start guides with explicit step-by-step instructions for restarting CLP after configuration changes
• Updated guidance to emphasize that configuration modifications require a complete stop-and-restart cycle rather than automatic application

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Walkthrough

Updated documentation in two quick-start guides to clarify that clp-config.yaml changes require restarting CLP rather than hot-reloading. Replaced vague instructions with explicit guidance to run sbin/stop-clp.sh followed by sbin/start-clp.sh.

Changes

Cohort / File(s)	Summary
Documentation Updates docs/src/user-docs/quick-start/clp-json.md, docs/src/user-docs/quick-start/clp-text.md	Clarified startup failure handling guidance by emphasizing non-hot-reload behaviour and providing explicit commands (stop-clp.sh, then start-clp.sh) for applying configuration changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related issues

• docs: Clarify when clp-config.yaml changes take effect #1795: These documentation updates directly address the issue by explicitly stating that clp-config.yaml requires CLP to be restarted (via stop-clp.sh and start-clp.sh) rather than being hot-reloaded.

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately summarizes the main change: clarifying that clp-config.yaml changes require a full service restart, which directly aligns with the documented updates to both quick-start guides.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

🤖 Fix all issues with AI agents

In `@docs/src/user-docs/quick-start/clp-text.md`:
- Around line 32-35: Replace the awkward lead-in "Keep in mind about
`etc/clp-config.yaml`:" with a clearer phrase—either "Keep in mind the following
about `etc/clp-config.yaml`:" or simply "Keep in mind:"—so the note reads
naturally before the bullet points; update the sentence containing the exact
text "Keep in mind about `etc/clp-config.yaml`" in clp-text.md accordingly.

[coderabbitai]

⚠️ Potential issue | 🟡 Minor

Tighten the note lead‑in wording for clarity.

“Keep in mind about …” is awkward; consider “Keep in mind:” or “Keep in mind the following about …”.

🤖 Prompt for AI Agents

In `@docs/src/user-docs/quick-start/clp-text.md` around lines 32 - 35, Replace the
awkward lead-in "Keep in mind about `etc/clp-config.yaml`:" with a clearer
phrase—either "Keep in mind the following about `etc/clp-config.yaml`:" or
simply "Keep in mind:"—so the note reads naturally before the bullet points;
update the sentence containing the exact text "Keep in mind about
`etc/clp-config.yaml`" in clp-text.md accordingly.