Skip to content

docs: apply consistent documentation style across README and docs/v2#333

Merged
jjuliano merged 19 commits into
mainfrom
feat/docs-rewrite
May 22, 2026
Merged

docs: apply consistent documentation style across README and docs/v2#333
jjuliano merged 19 commits into
mainfrom
feat/docs-rewrite

Conversation

@jjuliano

Copy link
Copy Markdown
Member

Summary

Applied consistent documentation style across 22 files:

  • ASCII flow diagrams for multi-step concepts (agency flow, LLM tool loop, DAG execution, mode fork)
  • Inline YAML comments explaining field behavior in context
  • Plain-English leads before every code block
  • Analogies for abstractions
  • Removed all dot-notation config references in favor of actual YAML blocks
  • Fixed stale run.validations: and run.chat: dot-notation references

Test plan

  • npm run build passes

🤖 Generated with Claude Code

jjuliano and others added 19 commits May 21, 2026 23:03
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>
@jjuliano jjuliano merged commit deed848 into main May 22, 2026
@jjuliano jjuliano changed the title docs: apply copy-pasta dev style across README and docs/v2 docs: apply consistent documentation style across README and docs/v2 May 22, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant