docs: fix 4 documentation discrepancies from nightly reconciliation#3859
Merged
docs: fix 4 documentation discrepancies from nightly reconciliation#3859
Conversation
…report Agent-Logs-Url: https://github.com/github/gh-aw-mcpg/sessions/56418c0a-191b-4e1d-928d-060e6d65c0ce Co-authored-by: lpcox <15877973+lpcox@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Fix documentation for payloadSizeThreshold configuration
docs: fix 4 documentation discrepancies from nightly reconciliation
Apr 15, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Updates project documentation to resolve nightly reconciliation findings by aligning documented configuration fields and contributor workflows with the actual gateway behavior and supported config formats.
Changes:
- Documented
connect_timeout,rate_limit_threshold, andrate_limit_cooldownindocs/CONFIGURATION.md. - Reclassified
payloadSizeThresholdinto the Gateway Configuration Fields table. - Added
make test-raceguidance toCONTRIBUTING.md.
Show a summary per file
| File | Description |
|---|---|
| docs/CONFIGURATION.md | Adds missing server config entries and reclassifies payloadSizeThreshold in the gateway config reference. |
| CONTRIBUTING.md | Documents the existing make test-race target for Go race detection. |
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: 3
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Nightly reconciliation identified one inaccuracy and three missing entries across
docs/CONFIGURATION.mdandCONTRIBUTING.md.docs/CONFIGURATION.mdpayloadSizeThresholdmisclassified as TOML-only — it is defined inStdinGatewayConfigwithjson:"payloadSizeThreshold,omitempty"and actively consumed. Moved from the TOML-only/CLI-only table into the Gateway Configuration Fields table alongsidepayloadDir.connect_timeoutundocumented — per-server HTTP connection timeout (each transport attempt in the streamable HTTP → SSE sequence). Default:30s. HTTP servers only.rate_limit_threshold/rate_limit_cooldownundocumented — circuit breaker fields: afterrate_limit_threshold(default3) consecutive rate-limit errors the circuit opens;rate_limit_cooldown(default60s) controls the OPEN → HALF-OPEN probe interval. Available in TOML/JSON file configs; not available in JSON stdin format.CONTRIBUTING.mdmake test-raceundocumented — added a Race Detection Tests subsection noting this runsgo test -raceon./internal/...and is the right tool when touching concurrent code.