gemini-cli icon indicating copy to clipboard operation
gemini-cli copied to clipboard

Documentation Error: Incorrect nesting of `includeDirectories` in `settings.json` examples

Open gitenstuff opened this issue 1 month ago • 3 comments

Describe the documentation error

The documentation in docs/cli/configuration.md provides an example settings.json that uses the deprecated top-level includeDirectories key. The codebase (packages/cli/src/config/settings.ts) confirms that includeDirectories is migrated to context.includeDirectories. This migration was introduced in PR #7244 ("refactor: refactor settings to a nested structure").

Contradictory Example

In docs/cli/configuration.md, the "Example settings.json" snippet shows:

{
  ...
  "includeDirectories": ["path/to/dir1", "~/path/to/dir2", "../path/to/dir3"],
  ...
}

Expected Behavior

The documentation should reflect the current V2 schema structure:

{
  "context": {
    "includeDirectories": ["path/to/dir1", "~/path/to/dir2", "../path/to/dir3"]
  }
}

Additional Context

  • packages/cli/src/config/settings.ts contains includeDirectories: 'context.includeDirectories' in MIGRATION_MAP.
  • PR #7244 explicitly refactored settings to a nested structure.
  • Using the deprecated key triggers an internal migration or potential confusion for users expecting the modern schema.

gitenstuff avatar Dec 12 '25 01:12 gitenstuff

/assign

maru0804 avatar Dec 14 '25 08:12 maru0804

👋 @maru0804, you've been assigned to this issue! Thank you for taking the time to contribute. Make sure to check out our contributing guidelines.

gemini-cli[bot] avatar Dec 14 '25 08:12 gemini-cli[bot]

I've created a PR to fix this issue: #15067

This updates the documentation to use the correct V2 nested schema structure for includeDirectories settings.

maru0804 avatar Dec 14 '25 09:12 maru0804