docs: refine environment variable descriptions in configuration

[amranite]

Updated some descriptions for several environment variables to improve clarity and consistency.

[coderabbitai]

Walkthrough

Documentation update to configuration reference file revising parameter descriptions for clarity and consistency. Added two new worker-related configuration entries: ASSET_PREPROCESSING_NUM_WORKERS and RULE_ENGINE_NUM_WORKERS. Existing descriptions rewarded for improved guidance, grammar, and terminology standardization.

Changes

Cohort / File(s)

Summary

Configuration Documentation Updates docs/docs/03-configuration.md

Updated descriptions for PORT, WORKERS_HOST, WORKERS_ENABLED_WORKERS, WORKERS_DISABLED_WORKERS, DATA_DIR, ASSETS_DIR, NEXTAUTH_URL, PROMETHEUS_AUTH_TOKEN, and DB_WAL_MODE for clarity and consistency. Added ASSET_PREPROCESSING_NUM_WORKERS and RULE_ENGINE_NUM_WORKERS entries under CRAWLER configs with default values. Applied wording refinements including "Comma separated" to "Comma-separated" standardization and terminology adjustments throughout.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

• Documentation-only changes with no functional code modifications
• Primarily rewording and terminology standardization for consistency
• Two new configuration entries added with straightforward documentation

Pre-merge checks

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The PR title accurately summarizes the main change: refining environment variable descriptions in the configuration documentation.
Description check	✅ Passed	The PR description is related to the changeset, describing improvements to environment variable documentation for clarity and consistency.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

---

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: 0

🧹 Nitpick comments (1)

docs/docs/03-configuration.md (1)

7-7: Clarify the Docker port mapping instruction.

The phrase "change the docker bound external port" is imprecise. Consider rephrasing to "change the port mapping in your Docker configuration" or similar for clarity.

-| PORT                            | No                                    | 3000            | The port on which the web server will listen. DON'T CHANGE THIS IF YOU'RE USING DOCKER; instead, change the docker bound external port.                                                                                                                                                                                 |
+| PORT                            | No                                    | 3000            | The port on which the web server will listen. DON'T CHANGE THIS IF YOU'RE USING DOCKER; instead, change the port mapping in your Docker configuration.                                                                                                                                                                 |

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0316148 and 4d8e6dc.

📒 Files selected for processing (1)

• docs/docs/03-configuration.md (1 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

docs/docs/03-configuration.md

📄 CodeRabbit inference engine (AGENTS.md)

Project configuration options are documented in docs/docs/03-configuration.md

Files:

• docs/docs/03-configuration.md

🔇 Additional comments (4)

docs/docs/03-configuration.md (4)

9-14: Improved clarity on configuration behavior.

The rewording of WORKERS_HOST, WORKERS_ENABLED_WORKERS, WORKERS_DISABLED_WORKERS, DATA_DIR, ASSETS_DIR, and NEXTAUTH_URL descriptions provides better context and specificity. The additions about database location, default asset directory behavior, and sign-out consequences are particularly helpful.

---

19-20: Enhanced detail on token configuration and requirements.

The expanded PROMETHEUS_AUTH_TOKEN description now includes important constraints (no special characters) and clarifies the startup behavior. The DISABLE_NEW_RELEASE_CHECK description is concise and clear.

---

22-22: Improved WAL mode guidance.

The DB_WAL_MODE description now better explains the performance benefit and provides important context about network-attached storage limitations.

---

26-27: New worker configuration entries are properly integrated.

The two new entries (ASSET_PREPROCESSING_NUM_WORKERS and RULE_ENGINE_NUM_WORKERS) follow the established format, include helpful descriptions aligned with concurrent worker pattern, and are placed logically within the Crawler Configs section. Default values of 1 and guidance on when to increase them are consistent with similar entries.