Merged
Conversation
Add missing SessionConfig options (clientName, agent, onEvent) to reference table. Add 13 undocumented event types with new sections for External Tool, Permission, Command, and Plan Mode events. Add session.log() and early event registration sections to advanced.md. Add onListModels to setup.md CopilotClientOptions table. Add disableResume and onEvent to resume options table.
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the Maven site documentation to close gaps in feature coverage across configuration references and event documentation for the Copilot SDK for Java.
Changes:
- Expanded
SessionConfigand resume options reference tables to include additional configuration fields (clientName,agent,onEvent, etc.). - Extended the Event Types Reference with additional event types, including new categorized sections (external tool, permission, command, plan mode).
- Added advanced-guide sections documenting
CopilotSession.log()and early event registration viaSessionConfig.setOnEvent().
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| src/site/markdown/setup.md | Adds onListModels to the CopilotClientOptions reference table. |
| src/site/markdown/documentation.md | Adds missing config options and expands the event type reference tables/sections. |
| src/site/markdown/advanced.md | Documents session logging and early event registration; updates TOC accordingly. |
You can also share your feedback on Copilot code review. Take the survey.
Co-authored-by: Copilot <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.
Summary
Fixes documentation coverage gaps identified by a comprehensive documentation coverage assessment. The assessment found 84% coverage (105/125 features documented) — this PR closes the remaining gaps.
Changes
src/site/markdown/documentation.mdclientName,agent, andonEventoptionsExternalToolRequestedEvent,ExternalToolCompletedEvent)PermissionRequestedEvent,PermissionCompletedEvent)CommandQueuedEvent,CommandCompletedEvent)ExitPlanModeRequestedEvent,ExitPlanModeCompletedEvent)SessionModeChangedEvent,SessionPlanChangedEvent,SessionWorkspaceFileChangedEvent)SystemNotificationEvent)agent,disableResume, andonEventoptionssrc/site/markdown/advanced.mdsession.log()API with parameter table and usage examplesSessionConfig.setOnEvent()for capturing events during session creationsrc/site/markdown/setup.mdonListModelstoCopilotClientOptionsConfiguration Reference tableTesting