Commit 066a69c
Docs normalization for the SDK -> Docs pipeline (#1208)
* Convert headings to sentence case across all SDK docs
Convert 402 headings from title case to sentence case across 31
markdown files to align with docs.github.com style conventions.
Proper nouns (GitHub, Copilot, OAuth, Azure, MCP, etc.) and code
identifiers (SessionConfig, TelemetryConfig, etc.) are preserved.
Ampersands replaced with 'and'. No code snippet contents modified.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
* Restructure index.md files for docs pipeline compatibility
Move rich content out of index.md files into standalone articles:
- setup/index.md → setup/choosing-a-setup-path.md
- hooks/index.md → hooks/hooks-overview.md
Replace all index.md files with minimal nav pages matching the
docs-internal pattern (YAML-only category pages on that side).
Add missing index.md files for directories that lacked them:
- integrations/index.md
- observability/index.md
- troubleshooting/index.md
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
* Convert callout syntax to GitHub-flavored alerts
Convert 27 callouts across 15 files from bold-text style
(> **Note:**) to GitHub alert syntax (> [!NOTE]).
Language-qualified tips (e.g., > **Tip (Python / Go):**) preserve
the qualifier as bold text in the alert body.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
* Update internal links for restructured index files
Point 7 content links to their new standalone files:
- auth/index.md → auth/authenticate.md
- hooks/index.md → hooks/hooks-overview.md
Links in docs/index.md (root nav) intentionally still point to
index.md since those are category navigation links.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
* Convert list markers from hyphens to asterisks
Convert 371 unordered list markers across 37 files from `-` to
`*` to match the GitHub Docs style guide convention.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
* Normalize ordered list numbering to all 1.
Convert 116 sequentially numbered list items across 20 files to
use 1. for every item, matching the GitHub Docs style guide.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
* Remove horizontal rules used as section dividers
Remove 37 horizontal rules (---) across 7 files. GitHub Docs style
uses headings to separate sections, not horizontal rules.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
* Normalize em dash usage across all docs
Convert 79 list item em dashes to colons (label: description pattern)
and remove spaces around 114 mid-sentence em dashes to match the
GitHub Docs style guide.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
* Potential fix for pull request finding
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
* Potential fix for pull request finding
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
* Potential fix for pull request finding
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
* Remove bold from headings in remote-sessions.md
Fix 10 headings that used bold markers (**) in heading titles
and apply proper noun casing for language names.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
---------
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>1 parent bf3bdea commit 066a69c
39 files changed
Lines changed: 1952 additions & 1956 deletions
File tree
- docs
- auth
- features
- hooks
- integrations
- observability
- setup
- troubleshooting
Large diffs are not rendered by default.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | | - | |
| 1 | + | |
2 | 2 | | |
3 | 3 | | |
4 | 4 | | |
5 | | - | |
| 5 | + | |
6 | 6 | | |
7 | 7 | | |
8 | 8 | | |
| |||
13 | 13 | | |
14 | 14 | | |
15 | 15 | | |
16 | | - | |
| 16 | + | |
17 | 17 | | |
18 | 18 | | |
19 | 19 | | |
| |||
196 | 196 | | |
197 | 197 | | |
198 | 198 | | |
199 | | - | |
| 199 | + | |
200 | 200 | | |
201 | | - | |
| 201 | + | |
202 | 202 | | |
203 | 203 | | |
204 | 204 | | |
| |||
209 | 209 | | |
210 | 210 | | |
211 | 211 | | |
212 | | - | |
| 212 | + | |
213 | 213 | | |
214 | 214 | | |
215 | 215 | | |
216 | | - | |
217 | | - | |
| 216 | + | |
| 217 | + | |
218 | 218 | | |
219 | | - | |
| 219 | + | |
220 | 220 | | |
221 | 221 | | |
222 | | - | |
223 | | - | |
| 222 | + | |
| 223 | + | |
224 | 224 | | |
225 | 225 | | |
226 | | - | |
227 | | - | |
228 | | - | |
| 226 | + | |
| 227 | + | |
| 228 | + | |
229 | 229 | | |
230 | 230 | | |
231 | | - | |
232 | | - | |
| 231 | + | |
| 232 | + | |
233 | 233 | | |
234 | | - | |
| 234 | + | |
235 | 235 | | |
236 | | - | |
| 236 | + | |
237 | 237 | | |
238 | 238 | | |
239 | 239 | | |
| |||
243 | 243 | | |
244 | 244 | | |
245 | 245 | | |
246 | | - | |
| 246 | + | |
247 | 247 | | |
248 | 248 | | |
249 | 249 | | |
| |||
258 | 258 | | |
259 | 259 | | |
260 | 260 | | |
261 | | - | |
| 261 | + | |
262 | 262 | | |
263 | 263 | | |
264 | 264 | | |
| |||
271 | 271 | | |
272 | 272 | | |
273 | 273 | | |
274 | | - | |
| 274 | + | |
275 | 275 | | |
276 | 276 | | |
277 | 277 | | |
| |||
293 | 293 | | |
294 | 294 | | |
295 | 295 | | |
296 | | - | |
| 296 | + | |
| 297 | + | |
297 | 298 | | |
298 | 299 | | |
299 | 300 | | |
| |||
322 | 323 | | |
323 | 324 | | |
324 | 325 | | |
325 | | - | |
| 326 | + | |
326 | 327 | | |
327 | 328 | | |
328 | 329 | | |
| |||
334 | 335 | | |
335 | 336 | | |
336 | 337 | | |
337 | | - | |
| 338 | + | |
| 339 | + | |
338 | 340 | | |
339 | | - | |
| 341 | + | |
340 | 342 | | |
341 | 343 | | |
342 | 344 | | |
| |||
467 | 469 | | |
468 | 470 | | |
469 | 471 | | |
470 | | - | |
| 472 | + | |
471 | 473 | | |
472 | 474 | | |
473 | 475 | | |
474 | 476 | | |
475 | 477 | | |
476 | | - | |
| 478 | + | |
477 | 479 | | |
478 | 480 | | |
479 | 481 | | |
480 | 482 | | |
481 | 483 | | |
482 | | - | |
| 484 | + | |
483 | 485 | | |
484 | 486 | | |
485 | 487 | | |
486 | | - | |
487 | | - | |
488 | | - | |
489 | | - | |
| 488 | + | |
| 489 | + | |
| 490 | + | |
| 491 | + | |
490 | 492 | | |
491 | | - | |
| 493 | + | |
492 | 494 | | |
493 | 495 | | |
494 | 496 | | |
| |||
499 | 501 | | |
500 | 502 | | |
501 | 503 | | |
502 | | - | |
| 504 | + | |
503 | 505 | | |
504 | 506 | | |
505 | 507 | | |
| |||
516 | 518 | | |
517 | 519 | | |
518 | 520 | | |
519 | | - | |
| 521 | + | |
520 | 522 | | |
521 | 523 | | |
522 | 524 | | |
| |||
574 | 576 | | |
575 | 577 | | |
576 | 578 | | |
577 | | - | |
| 579 | + | |
578 | 580 | | |
579 | 581 | | |
580 | 582 | | |
| |||
586 | 588 | | |
587 | 589 | | |
588 | 590 | | |
589 | | - | |
| 591 | + | |
590 | 592 | | |
591 | 593 | | |
592 | 594 | | |
| |||
601 | 603 | | |
602 | 604 | | |
603 | 605 | | |
604 | | - | |
| 606 | + | |
605 | 607 | | |
606 | 608 | | |
607 | | - | |
608 | | - | |
| 609 | + | |
| 610 | + | |
609 | 611 | | |
610 | | - | |
| 612 | + | |
611 | 613 | | |
612 | | - | |
613 | | - | |
| 614 | + | |
| 615 | + | |
0 commit comments