Skip to content

Fix incorrect default values in docs and example config for startup/tool timeouts and domain#3652

Merged
lpcox merged 2 commits intomainfrom
copilot/fix-documentation-discrepancies
Apr 12, 2026
Merged

Fix incorrect default values in docs and example config for startup/tool timeouts and domain#3652
lpcox merged 2 commits intomainfrom
copilot/fix-documentation-discrepancies

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 12, 2026

Three documentation discrepancies between config_core.go constants and user-facing docs: startupTimeout/toolTimeout defaults were documented as 2× their actual values, and domain was documented as defaulting to "localhost" when it has no code-level default.

Changes

  • docs/CONFIGURATION.md — Gateway config table: startupTimeout 6030, toolTimeout 12060, domain default localhost(unset)
  • config.example.toml — Inline comments corrected: (default: 60)(default: 30) and (default: 120)(default: 60); explicit override values (60/120) intentionally kept as examples of non-default configuration

Authoritative source

// internal/config/config_core.go
DefaultStartupTimeout = 30   // seconds (per spec §4.1.3)
DefaultToolTimeout    = 60   // seconds (per spec §4.1.3)

Copilot AI changed the title [WIP] Fix documentation defaults for startupTimeout and toolTimeout Fix incorrect default values in docs and example config for startup/tool timeouts and domain Apr 12, 2026
Copilot AI requested a review from lpcox April 12, 2026 16:08
@lpcox lpcox marked this pull request as ready for review April 12, 2026 16:14
Copilot AI review requested due to automatic review settings April 12, 2026 16:14
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates user-facing documentation and the example TOML config to match the authoritative gateway defaults in internal/config/config_core.go (startup/tool timeouts) and to reflect that domain has no code-level default.

Changes:

  • Correct startupTimeout default from 6030 seconds in docs and example comments.
  • Correct toolTimeout default from 12060 seconds in docs and example comments.
  • Update domain default in docs from localhost(unset) to match code behavior.
Show a summary per file
File Description
docs/CONFIGURATION.md Fixes the gateway config table defaults for domain, startupTimeout, and toolTimeout to match code.
config.example.toml Fixes inline comment defaults for startup/tool timeouts while keeping non-default example values.

Copilot's findings

Tip

Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

  • Files reviewed: 2/2 changed files
  • Comments generated: 0

@lpcox lpcox merged commit dfac8a5 into main Apr 12, 2026
19 checks passed
@lpcox lpcox deleted the copilot/fix-documentation-discrepancies branch April 12, 2026 16:23
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.

📚 Documentation Reconciliation Report - 2026-04-12

3 participants