docs: fix EnableConfigDiscovery summary to accurately describe agent discovery behavior - #2019
Open
smz202000 wants to merge 2 commits into
Open
docs: fix EnableConfigDiscovery summary to accurately describe agent discovery behavior#2019smz202000 wants to merge 2 commits into
smz202000 wants to merge 2 commits into
Conversation
…discovery behavior The previous documentation incorrectly stated that custom instruction files are always loaded from the working directory regardless of the EnableConfigDiscovery setting. In practice, agent files (e.g. .github/agents/) are only discovered when EnableConfigDiscovery is true. Update the summary to clarify that: - Agent discovery is gated by EnableConfigDiscovery - Use SkipCustomInstructions to independently control instruction file loading Fixes github#1887
Replace the per-language doc comments for EnableConfigDiscovery (and its ResumeSessionConfig equivalent) with a single consistent description: 'Enables runtime discovery of supported configuration. Explicitly supplied configuration takes precedence over discovered values.' The previous wording varied by language and, in .NET/Go/Node.js/Python, incorrectly claimed that custom instruction files are always loaded regardless of this setting (github#1887) while omitting that agent discovery is gated by it. Rather than special-casing that one clarification in a single language, this applies one accurate, artifact-agnostic description everywhere EnableConfigDiscovery is documented: dotnet/src/Types.cs, go/types.go (SessionConfig + ResumeSessionConfig), nodejs/src/types.ts, python/copilot/client.py (create + resume), rust/src/types.rs (fields + builder methods on both configs), and java SessionConfig.java/ResumeSessionConfig.java setters. Files under src/generated/ (Node.js, Java, .NET, Rust, Go rpc/zrpc.go) are auto-generated from api.schema.json upstream and are intentionally left untouched. Fixes github#1887 Co-authored-by: Copilot <223556219+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
2 participants
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.
Summary
Fixes #1887
The previous documentation for
EnableConfigDiscoveryincorrectly stated that custom instruction files are "always loaded from the working directory regardless of this setting." In practice, agent files (e.g..github/agents/) are only discovered whenEnableConfigDiscoveryistrue.Changes
Updated the XML doc comment on
SessionConfig.EnableConfigDiscoveryindotnet/src/Types.csto:EnableConfigDiscoverySkipCustomInstructionsas the independent control for instruction file loadingBefore:
After: