{{ message }}
docs: correct ${VAR} expansion scope and add missing internal packages#7102
Merged
Conversation
Copilot
AI
changed the title
[WIP] Fix discrepancies in CONTRIBUTING.md documentation
docs: correct ${VAR} expansion scope and add missing internal packages
Jun 6, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates repository documentation to accurately describe where ${VAR} expansion is supported in TOML configuration and to reflect newly added internal packages in the documented project structure.
Changes:
- Corrects docs to indicate
${VAR}expansion is supported in TOML only for[gateway.opentelemetry](not legacy[gateway.tracing]). - Updates
config.example.tomlcomments in two places to remove incorrect claims about[gateway.tracing]expansion. - Adds
internal/jsonutil/andinternal/mcpresult/to the documented project structure inCONTRIBUTING.md.
Show a summary per file
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: 2
|
|
||
| - JSON stdin configuration with `${VAR}` variable expansion | ||
| - TOML configuration loaded from file (no `${VAR}` variable expansion) | ||
| - TOML configuration loaded from file (`${VAR}` expansion supported only in `[gateway.opentelemetry]` section fields: `endpoint`, `traceId`, `spanId`, `headers`) |
Comment on lines
+252
to
+254
| # - Use ${VAR_NAME} syntax to reference environment variables in JSON stdin format only | ||
| # - TOML does not support ${VAR_NAME} expansion in server args/env fields; use absolute paths instead | ||
| # - The [gateway.opentelemetry] and [gateway.tracing] sections do support ${VAR_NAME} expansion | ||
| # - The [gateway.opentelemetry] section supports ${VAR_NAME} expansion; the legacy [gateway.tracing] section does not |
Collaborator
|
@copilot address review feedback |
Contributor
Author
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.
Three documentation discrepancies found by the nightly reconciliation check: two incorrectly described
${VAR}expansion scope (claiming[gateway.tracing]supports it when it doesn't), and one omitted newly-added internal packages from the project structure.Changes
CONTRIBUTING.md— Architecture Notes[gateway.opentelemetry]section fields (endpoint,traceId,spanId,headers) do support${VAR}expansion viaexpandTracingVariables(); the legacy[gateway.tracing]section does not. The prior note said TOML has no expansion at all.config.example.toml— two locations (Example 4 note + Notes section)[gateway.opentelemetry]and[gateway.tracing]support${VAR}expansion. Only[gateway.opentelemetry]does —expandTracingVariables()is guarded byif cfg.Gateway.Opentelemetry != niland is never reached for the legacy tracing path. Silent no-op substitution in[gateway.tracing]would produce malformed OTLP auth headers.CONTRIBUTING.md— Project Structureinternal/jsonutil/(JSON deep-clone utilities) andinternal/mcpresult/(MCP result text content helpers) to both the directory tree and Key Directories list.