docs: complete docs/v2 style pass -- plain-English leads, diagrams, inline YAML comments#334
Merged
Conversation
Remove 13 stale resource/tutorial files (telephony, tts, calendar, email, pdf, autopilot, remote-agent, memory, search-local, search-web, advanced/events, advanced/static-analysis, tutorials/). Add modes/ section with dedicated pages for workflow, agent, and MCP modes. Rebuild sidebar in config.ts. Update index, quickstart, and resource pages to match current schema and eliminate references to removed features. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
kdeps mcp now accepts an optional path (workflow.yaml, agency.yaml, or a directory). Every actionId in the workflow becomes an MCP tool, identical to how serve registers tools for the agent loop. Agencies register resources from all agent workflows. Directory input auto-discovers workflow or agency file via ResolveDirectoryPath. Without a path, built-in fformat tools are served as before. kdeps serve also gains directory support via the same resolveMCPPath helper. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Each workflow becomes a single MCP tool named after metadata.name. Calling it runs the full DAG via eng.Execute, identical to kdeps run. Add WorkflowToolDef to tools package. Remove the brain-damaged per-actionId tool registration from mcp mode. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
kdeps mcp had no distinct value over kdeps run. Deleted cmd/mcp.go, pkg/mcp/, WorkflowToolDef, and all docs/README references. Moved the path-resolution helper into serve.go which still uses it for directory support. Updated CLAUDE.md to reflect two modes only. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Remove MCP tools section from concepts/tools.md (mcp: field not implemented). Strip "MCP extensions" mention from why-kdeps.md. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
The mcp: field on chat tool definitions is fully implemented (pkg/tools/mcp/client.go, domain MCPConfig, llm executor dispatch). Restore the External MCP Tools section that was incorrectly removed. Also trim "and MCP extensions" from why-kdeps.md intro sentence. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Reframe why-kdeps around two modes. Remove Chat AI vs kdeps table (misleading since kdeps serve is itself an interactive LLM loop). Clarify workflow mode = production appliance, agent mode = interactive with custom toolset. Delete mcp-mode.md which reappeared via merge. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Add ASCII flow diagrams, inline YAML comments, plain-English leads, and analogies throughout. Remove dot-notation config references. 22 files updated. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Replaced <span v-pre> inside fenced code blocks with proper <div v-pre> wrappers. Inside code blocks, <span v-pre> renders as literal HTML text rather than preventing Vue template interpolation. Also removed duplicate heading in python.md and tightened the lead sentence. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- Plain-English lead sentence on every page - ASCII diagrams for multi-step/flow concepts (expr-blocks, inline-resources) - Inline YAML comments on non-obvious fields - Bullet walls replaced with YAML blocks or prose where appropriate - Removed dot-notation config references in favour of full YAML blocks - em dashes replaced with hyphens throughout Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- configuration/workflow.md: add ASCII diagram showing how apiServer, webServer, agentSettings, sqlConnections and session relate to the request lifecycle - configuration/advanced.md: add ASCII request-gate chain diagram (auth -> rate limit -> body size -> concurrency -> DAG) - deployment/kubernetes.md: add inline comments to generated Deployment manifest (readinessProbe, livenessProbe, resource limits/requests) - deployment/webserver.md: add ASCII routing diagram showing path-prefix dispatch to apiServer / subprocess / static files - examples/showcase.md: add request/response pattern diagram at the top Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- deployment/docker.md: convert "What's Included" bullets to directory tree - deployment/prepackage.md: fix dot-notation settings.apiServer.portNum (Rule 4) - advanced/validation-and-control.md: replace two "How It Works" bullet lists with prose - resources/llm.md: replace "Advanced Parameters" bullet wall with YAML + inline comments - reference/cli-reference.md: fix floating disconnected bullet - reference/expression-functions-reference.md: add intro sentence to each function group section Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
<span v-pre>rendering bugs inside fenced code blocks (python.md, exec.md, sql.md, session.md)Test plan
<span v-pre>inside fenced code blocks🤖 Generated with Claude Code