Nan Gao 7d1aa00136
docs(subagents): restructure the subagent docs into an eleven-chapter user manual (#5761)
* docs(subagents): restructure the subagent docs into an eleven-chapter user manual

Replace the single harness/subagents.mdx page (en + zh) with a
harness/subagents/ section of eleven chapters per language:

  1. index          concepts, delegation flow, inheritance, terminology
  2. quick-start    Ultra mode, task card, results, stop behaviour
  3. catalog        built-ins, config.yaml / managed sources, precedence,
                    Custom Agent delegation scope, ACP agents
  4. delegation     task parameters, snapshot context, acceptance criteria,
                    batch_task, skills / MCP / uploads inside a subagent
  5. results        terminal statuses, stop_reason, report contract,
                    receipt verification, acceptance checklist, ledger
  6. limits         every limit with key / default / range / behaviour,
                    runaway guards, subagent_runtime capacity
  7. sandbox        leases, per-subagent shell sessions, MAX_SHELL_SESSIONS,
                    middleware chain, execution isolation
  8. observability  task card, SSE + persisted events, metadata keys,
                    token attribution, Langfuse, trace ids, batch API
  9. troubleshooting symptom-indexed FAQ with the fixing PRs
 10. developers     create_deerflow_agent, SubagentRuntime, contracts,
                    extensions, security boundaries, background registry
 11. reference      config keys, context keys, tool signatures, enums,
                    events, routes, June-September 2026 change log

The old page becomes the section index (asIndexPage), so existing links to
/docs/harness/subagents keep working; the two anchor links in
middlewares.mdx now point at limits#runaway-guards. Every chapter compiles
with @mdx-js/mdx and the docs link tests pass. Changelog entries added in
both languages.

* docs(subagents): fix the docs build and align the manual with the code

Remove the `index` key from both subagents `_meta.ts` files. The index page
is marked `asIndexPage`, so Nextra treats it as the folder itself; listing it
as a child failed `_meta` validation and returned 500 for every docs page.

Correct claims that disagreed with the backend, in both languages:
- GET /api/subagents is open to all users; only writes need an admin
- subagents use their own subagents.token_budget, not the Lead Agent's
- warn_threshold injects a model-visible warning, not just a log line
- [SUBAGENT LIMIT REACHED] and subagent_limit_capped fire only when the
  per-run total was already exhausted before the response
- per-response concurrency defaults to subagent_runtime.max_running
- batch tools are not registered when a supplied runtime lacks a batch
  service
- ask_clarification / present_files are default denies that a config.yaml
  agent can lift
- smaller fixes to result text formats, event payloads, batch item states,
  MAX_SHELL_SESSIONS handling, and UI labels

The changelog entry now says only page-level links survive the split.
2026-09-23 14:19:10 +08:00

37 lines
629 B
TypeScript

import type { MetaRecord } from "nextra";
const meta: MetaRecord = {
"quick-start": {
title: "Quick Start",
},
catalog: {
title: "Subagent Catalog",
},
delegation: {
title: "Delegating Work",
},
results: {
title: "Results and Acceptance",
},
limits: {
title: "Limits, Budgets, and Capacity",
},
sandbox: {
title: "Sandbox and Isolation",
},
observability: {
title: "Observability",
},
troubleshooting: {
title: "Troubleshooting",
},
developers: {
title: "Developers and Integration",
},
reference: {
title: "Reference",
},
};
export default meta;