Skip to content

Commit f4b0956

Browse files
patnikoCopilot
andauthored
docs: reorganize docs/ into intent-based sections (#723)
* docs: reorganize docs/ around user intent Restructure the docs folder from an organic flat layout into intent-based sections that are easier to navigate: - setup/ — get it running (was guides/setup/, moved up one level) - auth/ — configure access (unchanged) - features/ — build things (was guides/, scoped to SDK capabilities) - hooks/ — API reference per hook (unchanged, overview.md → index.md) - troubleshooting/ — fix problems (new, consolidates debugging + compatibility) - observability/ — monitoring (new, houses OpenTelemetry docs) Key changes: - Add docs/index.md as top-level table of contents with persona routing - Add docs/features/index.md as feature guide overview - Remove duplicate guides/setup/byok.md (auth/byok.md is source of truth) - Rename hooks/overview.md → hooks/index.md for consistency - Move mcp/overview.md → features/mcp.md, mcp/debugging.md → troubleshooting/ - Update all internal cross-references (verified zero broken links) - Expand README Quick Links to surface more documentation sections Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * docs: move Microsoft Agent Framework to new integrations/ section Create a dedicated integrations/ section at the bottom of the docs hierarchy for platform/framework-specific guides. Move MAF out of features/ since it's an integration pattern, not an SDK capability. This makes it easy to add future guides for other platforms alongside MAF. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 327a798 commit f4b0956

32 files changed

+163
-450
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -107,8 +107,12 @@ Please use the [GitHub Issues](https://github.com/github/copilot-sdk/issues) pag
107107

108108
## Quick Links
109109

110+
- **[Documentation](./docs/index.md)** – Full documentation index
110111
- **[Getting Started](./docs/getting-started.md)** – Tutorial to get up and running
112+
- **[Setup Guides](./docs/setup/index.md)** – Architecture, deployment, and scaling
111113
- **[Authentication](./docs/auth/index.md)** – GitHub OAuth, BYOK, and more
114+
- **[Features](./docs/features/index.md)** – Hooks, custom agents, MCP, skills, and more
115+
- **[Troubleshooting](./docs/troubleshooting/debugging.md)** – Common issues and solutions
112116
- **[Cookbook](https://github.com/github/awesome-copilot/blob/main/cookbook/copilot-sdk)** – Practical recipes for common tasks across all languages
113117
- **[More Resources](https://github.com/github/awesome-copilot/blob/main/collections/copilot-sdk.md)** – Additional examples, tutorials, and community resources
114118

docs/auth/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -355,4 +355,4 @@ await using var client = new CopilotClient(new CopilotClientOptions
355355

356356
- [BYOK Documentation](./byok.md) - Learn how to use your own API keys
357357
- [Getting Started Guide](../getting-started.md) - Build your first Copilot-powered app
358-
- [MCP Servers](../mcp) - Connect to external tools
358+
- [MCP Servers](../features/mcp.md) - Connect to external tools
File renamed without changes.
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -973,7 +973,7 @@ const session = await client.createSession({
973973

974974
For full type definitions, input/output field tables, and additional examples for every hook, see the API reference:
975975

976-
- [Hooks Overview](../hooks/overview.md)
976+
- [Hooks Overview](../hooks/index.md)
977977
- [Pre-Tool Use](../hooks/pre-tool-use.md)
978978
- [Post-Tool Use](../hooks/post-tool-use.md)
979979
- [User Prompt Submitted](../hooks/user-prompt-submitted.md)
@@ -985,4 +985,4 @@ For full type definitions, input/output field tables, and additional examples fo
985985
- [Getting Started](../getting-started.md)
986986
- [Custom Agents & Sub-Agent Orchestration](./custom-agents.md)
987987
- [Streaming Session Events](./streaming-events.md)
988-
- [Debugging Guide](../debugging.md)
988+
- [Debugging Guide](../troubleshooting/debugging.md)
File renamed without changes.

docs/features/index.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Features
2+
3+
These guides cover the capabilities you can add to your Copilot SDK application. Each guide includes examples in all supported languages (TypeScript, Python, Go, and .NET).
4+
5+
> **New to the SDK?** Start with the [Getting Started tutorial](../getting-started.md) first, then come back here to add more capabilities.
6+
7+
## Guides
8+
9+
| Feature | Description |
10+
|---|---|
11+
| [Hooks](./hooks.md) | Intercept and customize session behavior — control tool execution, transform results, handle errors |
12+
| [Custom Agents](./custom-agents.md) | Define specialized sub-agents with scoped tools and instructions |
13+
| [MCP Servers](./mcp.md) | Integrate Model Context Protocol servers for external tool access |
14+
| [Skills](./skills.md) | Load reusable prompt modules from directories |
15+
| [Image Input](./image-input.md) | Send images to sessions as attachments |
16+
| [Streaming Events](./streaming-events.md) | Subscribe to real-time session events (40+ event types) |
17+
| [Steering & Queueing](./steering-and-queueing.md) | Control message delivery — immediate steering vs. sequential queueing |
18+
| [Session Persistence](./session-persistence.md) | Resume sessions across restarts, manage session storage |
19+
20+
## Related
21+
22+
- [Hooks Reference](../hooks/index.md) — detailed API reference for each hook type
23+
- [Integrations](../integrations/microsoft-agent-framework.md) — use the SDK with other platforms (MAF, etc.)
24+
- [Troubleshooting](../troubleshooting/debugging.md) — when things don't work as expected
25+
- [Compatibility](../troubleshooting/compatibility.md) — SDK vs CLI feature matrix
Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -258,18 +258,18 @@ directories for different applications.
258258
| "Timeout" errors | Increase the `timeout` value or check server performance |
259259
| Tools work but aren't called | Ensure your prompt clearly requires the tool's functionality |
260260

261-
For detailed debugging guidance, see the **[MCP Debugging Guide](./debugging.md)**.
261+
For detailed debugging guidance, see the **[MCP Debugging Guide](../troubleshooting/mcp-debugging.md)**.
262262

263263
## Related Resources
264264

265265
- [Model Context Protocol Specification](https://modelcontextprotocol.io/)
266266
- [MCP Servers Directory](https://github.com/modelcontextprotocol/servers) - Community MCP servers
267267
- [GitHub MCP Server](https://github.com/github/github-mcp-server) - Official GitHub MCP server
268268
- [Getting Started Guide](../getting-started.md) - SDK basics and custom tools
269-
- [General Debugging Guide](../debugging.md) - SDK-wide debugging
269+
- [General Debugging Guide](.../troubleshooting/mcp-debugging.md) - SDK-wide debugging
270270

271271
## See Also
272272

273-
- [MCP Debugging Guide](./debugging.md) - Detailed MCP troubleshooting
273+
- [MCP Debugging Guide](../troubleshooting/mcp-debugging.md) - Detailed MCP troubleshooting
274274
- [Issue #9](https://github.com/github/copilot-sdk/issues/9) - Original MCP tools usage question
275275
- [Issue #36](https://github.com/github/copilot-sdk/issues/36) - MCP documentation tracking issue
Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -561,7 +561,7 @@ const session = await client.createSession({
561561
});
562562
```
563563

564-
> **Note:** Thresholds are context utilization ratios (0.0-1.0), not absolute token counts. See the [Compatibility Guide](../compatibility.md) for details.
564+
> **Note:** Thresholds are context utilization ratios (0.0-1.0), not absolute token counts. See the [Compatibility Guide](../troubleshooting/compatibility.md) for details.
565565
566566
## Limitations & Considerations
567567

@@ -621,6 +621,6 @@ await withSessionLock("user-123-task-456", async () => {
621621

622622
## Next Steps
623623

624-
- [Hooks Overview](../hooks/overview.md) - Customize session behavior with hooks
625-
- [Compatibility Guide](../compatibility.md) - SDK vs CLI feature comparison
626-
- [Debugging Guide](../debugging.md) - Troubleshoot session issues
624+
- [Hooks Overview](../hooks/index.md) - Customize session behavior with hooks
625+
- [Compatibility Guide](../troubleshooting/compatibility.md) - SDK vs CLI feature comparison
626+
- [Debugging Guide](../troubleshooting/debugging.md) - Troubleshoot session issues
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -365,4 +365,4 @@ If multiple skills provide conflicting instructions:
365365

366366
- [Custom Agents](../getting-started.md#create-custom-agents) - Define specialized AI personas
367367
- [Custom Tools](../getting-started.md#step-4-add-a-custom-tool) - Build your own tools
368-
- [MCP Servers](../mcp/overview.md) - Connect external tool providers
368+
- [MCP Servers](./mcp.md) - Connect external tool providers
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -575,5 +575,5 @@ class InteractiveChat {
575575

576576
- [Getting Started](../getting-started.md) — Set up a session and send messages
577577
- [Custom Agents](./custom-agents.md) — Define specialized agents with scoped tools
578-
- [Session Hooks](../hooks/overview.md) — React to session lifecycle events
578+
- [Session Hooks](../hooks/index.md) — React to session lifecycle events
579579
- [Session Persistence](./session-persistence.md) — Resume sessions across restarts

0 commit comments

Comments
 (0)