Files
local-deep-research/scripts
LearningCircuit 20fedc67b1 docs: add config docs generator script (#2134)
* docs: add config docs generator script

Add scripts/generate_config_docs.py that auto-generates
docs/CONFIGURATION.md from default settings JSON files and
env_definitions/ modules. Supports both database-managed settings
and pre-database env-only settings.

Extracted from PR #1393.

Co-authored-by: daryltucker <daryltucker@users.noreply.github.com>

* docs: improve config docs generator with auto-discovery, --check mode, and CI

- Auto-discover env_definitions modules instead of hardcoding filenames
- Extract additional AST fields: required, min/max_value, allowed_values,
  deprecated_env_var
- Expand env-only settings table with Type, Required, Constraints,
  Deprecated Alias columns
- Add --check mode (exit 1 when docs are stale) for CI validation
- Add inline gitleaks:allow on key extraction line
- Generate initial docs/CONFIGURATION.md covering all 18 JSON files and
  5 env_definitions modules
- Add check-config-docs.yml PR workflow (zero deps, stdlib only)
- Add docs regeneration step to version_check.yml
- Allowlist docs/CONFIGURATION.md in .gitleaks.toml (references env var
  names, not actual secrets)
- Add comprehensive tests (27 tests: unit, integration, check mode,
  error handling)

* docs: add CONFIGURATION.md references to README, env_configuration, and developing guides

* docs: regenerate CONFIGURATION.md after merge with main

Picks up db_config.cipher_memory_security default change (OFF -> ON).

---------

Co-authored-by: daryltucker <daryltucker@users.noreply.github.com>
2026-02-22 21:06:27 +01:00
..