Skip to content

Split usage docs into chapters and add MCP guide#71

Merged
JE-Chen merged 1 commit intomainfrom
dev
Apr 28, 2026
Merged

Split usage docs into chapters and add MCP guide#71
JE-Chen merged 1 commit intomainfrom
dev

Conversation

@JE-Chen
Copy link
Copy Markdown
Member

@JE-Chen JE-Chen commented Apr 28, 2026

Summary

  • Restructure each language's monolithic usage.rst into a usage/ chapter directory grouped into five captioned sections (Getting started, Local & transfer, Servers & integrations, Reliability & events, Configuration & extension).
  • Add a dedicated MCP chapter (usage/mcp.rst) for English / 简体中文 / 繁體中文 covering Claude Desktop and Claude Code integration: stdio transport, CLI flags (python -m automation_file mcp), embedding MCPServer from Python, allow-list / venv-interpreter config snippets, JSON-RPC smoke test, and security notes.
  • Refresh each top-level index.rst to point at usage/index and retire the old single-file usage.rst.

Test plan

  • sphinx-build -b html docs/source docs/_build/html exits 0
  • sphinx-build -b html docs/source.zh-CN docs/_build/html-zh-CN exits 0
  • sphinx-build -b html docs/source.zh-TW docs/_build/html-zh-TW exits 0
  • usage/mcp.html generated for all three languages

Restructure docs/source, docs/source.zh-CN, docs/source.zh-TW so the
monolithic usage.rst becomes a usage/ section directory grouped by topic
(getting started, local & transfer, servers & integrations, reliability
& events, configuration & extension). Add a dedicated MCP chapter for
each language documenting Claude Desktop and Claude Code integration.
@codacy-production
Copy link
Copy Markdown

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.

@sonarqubecloud
Copy link
Copy Markdown

@JE-Chen JE-Chen merged commit b673325 into main Apr 28, 2026
10 checks passed
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