Skip to content

Commit 3c194a1

Browse files
sunbryeCopilot
andcommitted
docs: fix formatting that breaks docs.github.com publishing
The docs/ content is synced to docs.github.com (via github/docs-internal), where it must meet that platform's style rules. Two recurring issues were being reintroduced and fixed by hand on every sync: * Unordered lists must use asterisks (*) not hyphens (-) on docs.github.com. Converted prose bullets in features/fleet-mode.md, features/hooks.md, and hooks/post-tool-use.md (code blocks and frontmatter left untouched). * Every table cell must have a value. Filled the empty AZURE_TOKEN_CREDENTIALS Example cell in setup/azure-managed-identity.md with ManagedIdentityCredential (matches the row's description and this page's Azure scenario). Note: intentionally-blank cells that represent structure (optional 'Required' columns in property tables, section-grouping rows in troubleshooting/ compatibility.md, and the corner cell of the setup/scaling.md comparison matrix) were left as-is. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 3440135 commit 3c194a1

4 files changed

Lines changed: 47 additions & 47 deletions

File tree

docs/features/fleet-mode.md

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -8,18 +8,18 @@ Fleet mode is useful when the work can be decomposed before execution and each u
88

99
Good fits include:
1010

11-
- Multi-file refactors where each worker owns a file, package, or language SDK.
12-
- Batch reviews where each worker checks a separate diff, module, or alert group.
13-
- Parallel research across independent repositories, services, or feature areas.
14-
- Documentation refreshes where each worker owns a page or topic.
15-
- Migration tasks where each worker can validate its own slice and report back.
11+
* Multi-file refactors where each worker owns a file, package, or language SDK.
12+
* Batch reviews where each worker checks a separate diff, module, or alert group.
13+
* Parallel research across independent repositories, services, or feature areas.
14+
* Documentation refreshes where each worker owns a page or topic.
15+
* Migration tasks where each worker can validate its own slice and report back.
1616

1717
Avoid fleet mode for:
1818

19-
- Sequential tasks where step 2 needs the concrete output from step 1.
20-
- Tightly coupled edits where workers would contend for the same files.
21-
- Small tasks that one synchronous sub-agent or the parent agent can finish quickly.
22-
- Tasks that require continuous shared reasoning rather than clear ownership.
19+
* Sequential tasks where step 2 needs the concrete output from step 1.
20+
* Tightly coupled edits where workers would contend for the same files.
21+
* Small tasks that one synchronous sub-agent or the parent agent can finish quickly.
22+
* Tasks that require continuous shared reasoning rather than clear ownership.
2323

2424
Fleet mode works best when the parent session can create clear units of work, assign one owner per unit, and define what each worker must return.
2525

@@ -321,29 +321,29 @@ Keep plugin-provided sub-agent types narrow and descriptive so the orchestrator
321321

322322
## Best practices
323323

324-
- Decompose the work into independent units before starting fleet mode.
325-
- Minimize dependencies between todos; dependencies reduce parallelism.
326-
- Give each todo a durable ID, a clear title, and a complete description.
327-
- Make each sub-agent own exactly one todo at a time.
328-
- Use background sub-agents for truly parallel work.
329-
- Use synchronous sub-agent calls for serialized steps or validation gates.
330-
- Provide each sub-agent with complete context; sub-agents are stateless across calls.
331-
- Include file paths, commands, expected outputs, and constraints in each worker prompt.
332-
- Do not dispatch a single background sub-agent; prefer a synchronous call or batch multiple workers in parallel.
333-
- Avoid assigning overlapping files to different workers unless the parent agent will reconcile conflicts explicitly.
334-
- Require every worker to report what it changed, how it validated the change, and what remains blocked.
335-
- Have the parent agent verify the combined result after workers finish.
324+
* Decompose the work into independent units before starting fleet mode.
325+
* Minimize dependencies between todos; dependencies reduce parallelism.
326+
* Give each todo a durable ID, a clear title, and a complete description.
327+
* Make each sub-agent own exactly one todo at a time.
328+
* Use background sub-agents for truly parallel work.
329+
* Use synchronous sub-agent calls for serialized steps or validation gates.
330+
* Provide each sub-agent with complete context; sub-agents are stateless across calls.
331+
* Include file paths, commands, expected outputs, and constraints in each worker prompt.
332+
* Do not dispatch a single background sub-agent; prefer a synchronous call or batch multiple workers in parallel.
333+
* Avoid assigning overlapping files to different workers unless the parent agent will reconcile conflicts explicitly.
334+
* Require every worker to report what it changed, how it validated the change, and what remains blocked.
335+
* Have the parent agent verify the combined result after workers finish.
336336

337337
## Limitations and open questions
338338

339-
- Fleet mode is exposed through generated session RPC bindings and is marked experimental in several SDKs.
340-
- The SQL todos pattern is the canonical coordination model in the runtime guidance, but whether it is a stable extensibility contract for SDK consumers is still an open question.
341-
- `subagentStart` and `subagentStop` are runtime hook names; this branch exposes sub-agent lifecycle to SDK consumers through the generic session event stream, not dedicated hook callbacks.
342-
- Plugin sub-agent registration is configured at the runtime layer through `--plugin-dir`; no SDK-level plugin registration helper was verified on this branch.
343-
- Java native typed bindings for `session.fleet.start` were not found in the Java SDK source on this branch.
344-
- Fleet mode does not remove the need for parent-agent review. Parallel workers can produce inconsistent assumptions that the orchestrator must reconcile.
339+
* Fleet mode is exposed through generated session RPC bindings and is marked experimental in several SDKs.
340+
* The SQL todos pattern is the canonical coordination model in the runtime guidance, but whether it is a stable extensibility contract for SDK consumers is still an open question.
341+
* `subagentStart` and `subagentStop` are runtime hook names; this branch exposes sub-agent lifecycle to SDK consumers through the generic session event stream, not dedicated hook callbacks.
342+
* Plugin sub-agent registration is configured at the runtime layer through `--plugin-dir`; no SDK-level plugin registration helper was verified on this branch.
343+
* Java native typed bindings for `session.fleet.start` were not found in the Java SDK source on this branch.
344+
* Fleet mode does not remove the need for parent-agent review. Parallel workers can produce inconsistent assumptions that the orchestrator must reconcile.
345345

346346
## See also
347347

348-
- [Custom agents and sub-agent orchestration](custom-agents.md)
349-
- [Hooks](hooks.md)
348+
* [Custom agents and sub-agent orchestration](custom-agents.md)
349+
* [Hooks](hooks.md)

docs/features/hooks.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1051,16 +1051,16 @@ const session = await client.createSession({
10511051

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

1054-
- [Hooks Overview](../hooks/hooks-overview.md)
1055-
- [Pre-Tool Use](../hooks/pre-tool-use.md)
1056-
- [Post-Tool Use](../hooks/post-tool-use.md)
1057-
- [User Prompt Submitted](../hooks/user-prompt-submitted.md)
1058-
- [Session Lifecycle](../hooks/session-lifecycle.md)
1059-
- [Error Handling](../hooks/error-handling.md)
1054+
* [Hooks Overview](../hooks/hooks-overview.md)
1055+
* [Pre-Tool Use](../hooks/pre-tool-use.md)
1056+
* [Post-Tool Use](../hooks/post-tool-use.md)
1057+
* [User Prompt Submitted](../hooks/user-prompt-submitted.md)
1058+
* [Session Lifecycle](../hooks/session-lifecycle.md)
1059+
* [Error Handling](../hooks/error-handling.md)
10601060

10611061
## See also
10621062

1063-
- [Getting Started](../getting-started.md)
1064-
- [Custom Agents & Sub-Agent Orchestration](./custom-agents.md)
1065-
- [Streaming Session Events](./streaming-events.md)
1066-
- [Debugging Guide](../troubleshooting/debugging.md)
1063+
* [Getting Started](../getting-started.md)
1064+
* [Custom Agents & Sub-Agent Orchestration](./custom-agents.md)
1065+
* [Streaming Session Events](./streaming-events.md)
1066+
* [Debugging Guide](../troubleshooting/debugging.md)

docs/hooks/post-tool-use.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22

33
The `onPostToolUse` hook is called **after** a tool executes **successfully**. Use it to:
44

5-
- Transform or filter tool results
6-
- Log tool execution for auditing
7-
- Add context based on results
8-
- Suppress results from the conversation
5+
* Transform or filter tool results
6+
* Log tool execution for auditing
7+
* Add context based on results
8+
* Suppress results from the conversation
99

1010
> **Failure variant**`onPostToolUse` only fires for successful tool executions. To observe **failed** tool calls, register `onPostToolUseFailure` (`on_post_tool_use_failure` in Python, `OnPostToolUseFailure` in Go/.NET, `on_post_tool_use_failure` in Rust). The handler receives `{ sessionId, toolName, toolArgs, error, timestamp, workingDirectory }` — the `error` field is a string extracted from the tool's failure result — and may return `{ additionalContext: string }` to inject extra guidance for the model (e.g. retry hints). See the [hooks overview](./hooks-overview.md) for the full list.
1111
> <a id="failure-variant"></a>
@@ -507,6 +507,6 @@ const session = await client.createSession({
507507

508508
## See also
509509

510-
- [Hooks Overview](./README.md)
511-
- [Pre-Tool Use Hook](./pre-tool-use.md)
512-
- [Error Handling Hook](./error-handling.md)
510+
* [Hooks Overview](./README.md)
511+
* [Pre-Tool Use Hook](./pre-tool-use.md)
512+
* [Error Handling Hook](./error-handling.md)

docs/setup/azure-managed-identity.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -233,7 +233,7 @@ await client.stop();
233233

234234
| Variable | Description | Example |
235235
|----------|-------------|---------|
236-
| `AZURE_TOKEN_CREDENTIALS` | When running in **Azure**, set it to `ManagedIdentityCredential`. When running **locally**, set it to either `dev` or a developer tool credential name, such as `AzureCliCredential`. | |
236+
| `AZURE_TOKEN_CREDENTIALS` | When running in **Azure**, set it to `ManagedIdentityCredential`. When running **locally**, set it to either `dev` or a developer tool credential name, such as `AzureCliCredential`. | `ManagedIdentityCredential` |
237237
| `FOUNDRY_RESOURCE_URL` | Your Microsoft Foundry resource URL | `https://<my-resource>.openai.azure.com` |
238238

239239
No API key environment variable is needed—authentication is handled by `DefaultAzureCredential`, which automatically supports:

0 commit comments

Comments
 (0)