Skip to content

docs(config): add a reference page for existing config files#484

Draft
Bortlesboat wants to merge 1 commit into
DeusData:mainfrom
Bortlesboat:docs/config-reference-issue-359
Draft

docs(config): add a reference page for existing config files#484
Bortlesboat wants to merge 1 commit into
DeusData:mainfrom
Bortlesboat:docs/config-reference-issue-359

Conversation

@Bortlesboat

Copy link
Copy Markdown

Closes #359.

This adds a focused config reference page for the files that already exist today and links to it from the README custom-extension section.

What it covers:

  • global and per-project �xtra_extensions JSON files
  • the CLI-managed _config.db settings store used by config set/get/reset
  • the UI config.json file and its current schema
  • a small note to use install --dry-run for tool-specific integration paths

Verification:

  • git diff --check
  • checked the documented paths and keys against src/discover/userconfig.h, src/cli/cli.c, and src/ui/config.c

Signed-off-by: Andrew Barnes <bortstheboat@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Where can I find docs for configuration files?

1 participant