Skip to content

Fix documentation coverage gaps#186

Merged
brunoborges merged 2 commits intomainfrom
docs/fix-documentation-coverage-gaps
Mar 12, 2026
Merged

Fix documentation coverage gaps#186
brunoborges merged 2 commits intomainfrom
docs/fix-documentation-coverage-gaps

Conversation

@brunoborges
Copy link
Member

@brunoborges brunoborges commented Mar 12, 2026

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.md

  • SessionConfig Reference table: Added missing clientName, agent, and onEvent options
  • Event Types Reference: Added 12 undocumented event types organized into new sections:
    • External Tool Events (ExternalToolRequestedEvent, ExternalToolCompletedEvent)
    • Permission Events (PermissionRequestedEvent, PermissionCompletedEvent)
    • Command Events (CommandQueuedEvent, CommandCompletedEvent)
    • Plan Mode Events (ExitPlanModeRequestedEvent, ExitPlanModeCompletedEvent)
    • Session events (SessionModeChangedEvent, SessionPlanChangedEvent, SessionWorkspaceFileChangedEvent)
    • Other events (SystemNotificationEvent)
  • Resume Options table: Added agent, disableResume, and onEvent options

src/site/markdown/advanced.md

  • Added Session Logging section documenting session.log() API with parameter table and usage examples
  • Added Early Event Registration section documenting SessionConfig.setOnEvent() for capturing events during session creation
  • Updated Table of Contents with new section links

src/site/markdown/setup.md

  • Added onListModels to CopilotClientOptions Configuration Reference table

Testing

  • Spotless check passes (0 violations)
  • Checkstyle passes (0 violations)
  • Documentation-only changes — no Java source code modified

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.
Copy link
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 the Maven site documentation to close gaps in feature coverage across configuration references and event documentation for the Copilot SDK for Java.

Changes:

  • Expanded SessionConfig and 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 via SessionConfig.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>
@brunoborges brunoborges requested review from edburns and removed request for edburns March 12, 2026 02:08
@brunoborges brunoborges merged commit 0adcbc0 into main Mar 12, 2026
5 checks passed
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.

2 participants