Skip to content

Commit ce2a2bd

Browse files
committed
feat: add Next Steps sections to multiple documentation files for improved navigation
1 parent 8c58cec commit ce2a2bd

5 files changed

Lines changed: 69 additions & 0 deletions

File tree

src/site/markdown/advanced.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -627,3 +627,13 @@ session.setEventErrorPolicy(EventErrorPolicy.SUPPRESS_AND_LOG_ERRORS);
627627
```
628628

629629
See [EventErrorPolicy](apidocs/com/github/copilot/sdk/EventErrorPolicy.html) and [EventErrorHandler](apidocs/com/github/copilot/sdk/EventErrorHandler.html) Javadoc for details.
630+
631+
---
632+
633+
## Next Steps
634+
635+
- 📖 **[Documentation](documentation.html)** - Core concepts, events, streaming, models, tool filtering, reasoning effort
636+
- 📖 **[Session Hooks](hooks.html)** - All 5 hook types with inputs, outputs, and examples
637+
- 📖 **[MCP Servers](mcp.html)** - Local and remote MCP server integration
638+
- 📖 **[Setup & Deployment](setup.html)** - OAuth, backend services, scaling, configuration reference
639+
- 📖 **[API Javadoc](apidocs/index.html)** - Complete API reference

src/site/markdown/documentation.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ This guide covers common use cases for the Copilot SDK for Java. For complete AP
1818
- [Connection State & Diagnostics](#Connection_State__Diagnostics)
1919
- [Message Delivery Mode](#Message_Delivery_Mode)
2020
- [Session Management](#Session_Management)
21+
- [SessionConfig Reference](#SessionConfig_Reference)
2122

2223
---
2324

@@ -563,6 +564,36 @@ client.deleteSession(sessionId).get();
563564

564565
---
565566

567+
## SessionConfig Reference
568+
569+
Complete list of all `SessionConfig` options for `createSession()`:
570+
571+
| Option | Type | Description | Guide |
572+
|--------|------|-------------|-------|
573+
| `sessionId` | String | Custom session ID (auto-generated if omitted) ||
574+
| `model` | String | AI model to use | [Choosing a Model](#Choosing_a_Model) |
575+
| `reasoningEffort` | String | Reasoning depth: `"low"`, `"medium"`, `"high"`, `"xhigh"` | [Reasoning Effort](#Reasoning_Effort) |
576+
| `tools` | List<ToolDefinition> | Custom tools the assistant can invoke | [Custom Tools](advanced.html#Custom_Tools) |
577+
| `systemMessage` | SystemMessageConfig | Customize assistant behavior | [System Messages](advanced.html#System_Messages) |
578+
| `availableTools` | List<String> | Allowlist of built-in tool names | [Tool Filtering](#Tool_Filtering) |
579+
| `excludedTools` | List<String> | Blocklist of built-in tool names | [Tool Filtering](#Tool_Filtering) |
580+
| `provider` | ProviderConfig | BYOK API provider configuration | [BYOK](advanced.html#Bring_Your_Own_Key_BYOK) |
581+
| `onPermissionRequest` | PermissionHandler | Handler for permission requests | [Permission Handling](advanced.html#Permission_Handling) |
582+
| `onUserInputRequest` | UserInputHandler | Handler for user input requests | [User Input Handling](advanced.html#User_Input_Handling) |
583+
| `hooks` | SessionHooks | Lifecycle and tool execution hooks | [Session Hooks](hooks.html) |
584+
| `workingDirectory` | String | Working directory for file operations | [Working Directory](#Working_Directory) |
585+
| `streaming` | boolean | Enable streaming response chunks | [Streaming Responses](#Streaming_Responses) |
586+
| `mcpServers` | Map<String, Object> | MCP server configurations | [MCP Servers](mcp.html) |
587+
| `customAgents` | List<CustomAgentConfig> | Custom agent definitions | [Custom Agents](advanced.html#Custom_Agents) |
588+
| `infiniteSessions` | InfiniteSessionConfig | Auto-compaction for long conversations | [Infinite Sessions](advanced.html#Infinite_Sessions) |
589+
| `skillDirectories` | List<String> | Directories to load skills from | [Skills](advanced.html#Skills_Configuration) |
590+
| `disabledSkills` | List<String> | Skills to disable by name | [Skills](advanced.html#Skills_Configuration) |
591+
| `configDir` | String | Custom configuration directory | [Config Dir](advanced.html#Custom_Configuration_Directory) |
592+
593+
See [SessionConfig](apidocs/com/github/copilot/sdk/json/SessionConfig.html) Javadoc for full details.
594+
595+
---
596+
566597
## Next Steps
567598

568599
- 📖 **[Advanced Usage](advanced.html)** - Tools, BYOK, MCP Servers, System Messages, Infinite Sessions, Skills

src/site/markdown/getting-started.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -349,3 +349,13 @@ copilot auth login
349349
### "Connection timeout"
350350

351351
Check your internet connection and firewall settings. The SDK communicates with GitHub's Copilot service.
352+
353+
---
354+
355+
## Next Steps
356+
357+
- 📖 **[Documentation](documentation.html)** - Core concepts, events, streaming, session management
358+
- 📖 **[Advanced Usage](advanced.html)** - Tools, BYOK, MCP Servers, System Messages, Custom Agents
359+
- 📖 **[Session Hooks](hooks.html)** - Intercept tool execution and session lifecycle events
360+
- 📖 **[Setup & Deployment](setup.html)** - OAuth, backend services, scaling
361+
- 📖 **[API Javadoc](apidocs/index.html)** - Complete API reference

src/site/markdown/hooks.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -393,3 +393,12 @@ To handle errors gracefully in your hooks:
393393
- [PreToolUseHookOutput Javadoc](apidocs/com/github/copilot/sdk/json/PreToolUseHookOutput.html)
394394
- [PostToolUseHookInput Javadoc](apidocs/com/github/copilot/sdk/json/PostToolUseHookInput.html)
395395
- [PostToolUseHookOutput Javadoc](apidocs/com/github/copilot/sdk/json/PostToolUseHookOutput.html)
396+
397+
---
398+
399+
## Next Steps
400+
401+
- 📖 **[Documentation](documentation.html)** - Core concepts, events, session management
402+
- 📖 **[Advanced Usage](advanced.html)** - Tools, BYOK, MCP Servers, Custom Agents
403+
- 📖 **[MCP Servers](mcp.html)** - Integrate external tools via Model Context Protocol
404+
- 📖 **[API Javadoc](apidocs/index.html)** - Complete API reference

src/site/markdown/mcp.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -115,3 +115,12 @@ var session = client.createSession(
115115
- [MCP Specification](https://modelcontextprotocol.io/)
116116
- [MCP Servers Directory](https://github.com/modelcontextprotocol/servers)
117117
- [GitHub MCP Server](https://github.com/github/github-mcp-server)
118+
119+
---
120+
121+
## Next Steps
122+
123+
- 📖 **[Documentation](documentation.html)** - Core concepts, events, session management
124+
- 📖 **[Advanced Usage](advanced.html)** - Tools, BYOK, System Messages, Custom Agents
125+
- 📖 **[Session Hooks](hooks.html)** - Intercept tool execution and session lifecycle events
126+
- 📖 **[API Javadoc](apidocs/index.html)** - Complete API reference

0 commit comments

Comments
 (0)