Commit f4b0956
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
File tree
32 files changed
+163
-450
lines changed- docs
- auth
- features
- guides/setup
- hooks
- integrations
- observability
- setup
- troubleshooting
32 files changed
+163
-450
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
107 | 107 | | |
108 | 108 | | |
109 | 109 | | |
| 110 | + | |
110 | 111 | | |
| 112 | + | |
111 | 113 | | |
| 114 | + | |
| 115 | + | |
112 | 116 | | |
113 | 117 | | |
114 | 118 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
355 | 355 | | |
356 | 356 | | |
357 | 357 | | |
358 | | - | |
| 358 | + | |
File renamed without changes.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
973 | 973 | | |
974 | 974 | | |
975 | 975 | | |
976 | | - | |
| 976 | + | |
977 | 977 | | |
978 | 978 | | |
979 | 979 | | |
| |||
985 | 985 | | |
986 | 986 | | |
987 | 987 | | |
988 | | - | |
| 988 | + | |
File renamed without changes.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
258 | 258 | | |
259 | 259 | | |
260 | 260 | | |
261 | | - | |
| 261 | + | |
262 | 262 | | |
263 | 263 | | |
264 | 264 | | |
265 | 265 | | |
266 | 266 | | |
267 | 267 | | |
268 | 268 | | |
269 | | - | |
| 269 | + | |
270 | 270 | | |
271 | 271 | | |
272 | 272 | | |
273 | | - | |
| 273 | + | |
274 | 274 | | |
275 | 275 | | |
Lines changed: 4 additions & 4 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
561 | 561 | | |
562 | 562 | | |
563 | 563 | | |
564 | | - | |
| 564 | + | |
565 | 565 | | |
566 | 566 | | |
567 | 567 | | |
| |||
621 | 621 | | |
622 | 622 | | |
623 | 623 | | |
624 | | - | |
625 | | - | |
626 | | - | |
| 624 | + | |
| 625 | + | |
| 626 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
365 | 365 | | |
366 | 366 | | |
367 | 367 | | |
368 | | - | |
| 368 | + | |
Lines changed: 1 addition & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
575 | 575 | | |
576 | 576 | | |
577 | 577 | | |
578 | | - | |
| 578 | + | |
579 | 579 | | |
0 commit comments