docs: Some fixes for Configuration page and remove Env Var reference page #1516

Merged
Jade merged 7 commits from stratself/continuwuity:stratself/docs-config-env-var-fixes into main 2026-04-15 13:18:59 +00:00

7 commits

Author SHA1 Message Date
96be3924f9 fix(docs): Apply more changes to improve clarity and grammar
All checks were successful
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Checks / Changelog / Check changelog is added (pull_request_target) Successful in 30s
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 1m20s
Checks / Prek / Clippy and Cargo Tests (pull_request) Successful in 8m4s
* CONTINUWUITY_WELL_KNOWN requires a "Struct", not a JSON array
* Fix all instances of Intl English to English English
* Typo/grammar nits fixings
2026-04-14 16:41:46 +00:00
f2522e0c43 fix(docs): Remove bash shell indicator 2026-04-14 16:41:46 +00:00
4a5f6cc6a5 fix(docs): Apply some suggestions to improve docs clarity
* fix(docs): Change all "commandline" to "command-line"
* fix(docs): Standardize "config options" as the word to use for config
  file params
2026-04-14 16:41:46 +00:00
c3ecb6e69d docs: Remove the manually-generated env var reference page and its links
Maybe configuration.mdx could be rewritten for better clarity on
converting between config param <-> env var
2026-04-14 16:41:45 +00:00
cd643c5c90 docs: Add order of config priority and rewrite --execute command info
* fix(docs): smaller wordings

May need to consider a separate section for "runtime configuration"
i.e. --execute and --maintenance modes
2026-04-14 16:41:45 +00:00
4fdc65e934 docs: Rework environment variable section in Configuration docs
* docs: Move detailed explanations in Env Var ref page to Config page
* docs: Add env var example for double nested configs and array
  declaration
2026-04-14 16:41:45 +00:00
341c112e9b docs: Add Env Var reference page to navigation bar 2026-04-14 16:41:45 +00:00