docs: Clarify when clp-config.yaml changes take effect

[junhaoliao]

(Thanks to @Theo-automate for sharing this valuable feedback offline!)

Description

The current documentation does not clearly specify when changes made to clp-config.yaml are applied by the system.

A user reported that after modifying clp-config.yaml and restarting the container, the new configuration was not picked up. The changes only took effect after running a full service restart via:

cd clp-package
./stop-clp.sh
./start-clp.sh

This behavior is correct, but it is not explicitly documented and can be confusing for users.

Docs improvement

• Clearly state that changes to clp-config.yaml are not hot-reloaded.
• Explicitly document that users must run stop-clp.sh followed by start-clp.sh for configuration changes to take effect.

[coderabbitai]

📝 CodeRabbit Plan Mode

Generate an implementation plan and prompts that you can use with your favorite coding agent.

• Create Plan

Examples

• Example 1
• Example 2

_{You can configure auto-planning by selecting labels in the issue_enrichment configuration.}

🔗 Similar Issues

Related Issues

• docs: Missing reference doc for clp-config.yml #1233
• Support configuring restart policy of services in the Package Compose project #1747
• Documentation: Specify directories for commands in Log Viewer WebUI Running section #836
• Document that CLP is timezoneless and requires timezoneless timestamps in queries #1433

👤 Suggested Assignees

• junhaoliao
• coderabbitai

---

🧪 Issue enrichment is currently in open beta.

To disable automatic issue enrichment, add the following to your .coderabbit.yaml:

issue_enrichment:
  auto_enrich:
    enabled: false

💬 Have feedback or questions? Drop into our discord or schedule a call!