Skip to content

docs: refresh debug and config resolution help#251

Open
haosenwang1018 wants to merge 1 commit intophilschmid:mainfrom
haosenwang1018:docs/refresh-debug-and-config-resolution
Open

docs: refresh debug and config resolution help#251
haosenwang1018 wants to merge 1 commit intophilschmid:mainfrom
haosenwang1018:docs/refresh-debug-and-config-resolution

Conversation

@haosenwang1018
Copy link
Copy Markdown

Summary

  • document merged default config loading in the README and CLI help
  • add the new --debug flag to help output and debugging examples
  • align the user-facing docs with the current runtime behavior

Problem

Several recent UX improvements are implemented but not yet reflected in the docs/help output:

  • default config discovery now merges multiple config files
  • the CLI now supports a one-off --debug flag

Without doc updates, users still see stale config resolution behavior and may miss the new debug path.

Changes

  • update the README config resolution section to describe single-file explicit configs vs merged default configs
  • add --debug to the CLI help output and environment variable list
  • add a one-off debug example in the README connection pooling section

Validation

  • git diff --check
  • npx tsc --noEmit
  • npx @biomejs/biome check src/index.ts README.md

Signed-off-by: haosenwang1018 <haosenwang1018@users.noreply.github.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.

1 participant