Skip to content

Docs reorg into chapters + MCP Claude guide#95

Merged
JE-Chen merged 2 commits intomainfrom
dev
Apr 28, 2026
Merged

Docs reorg into chapters + MCP Claude guide#95
JE-Chen merged 2 commits intomainfrom
dev

Conversation

@JE-Chen
Copy link
Copy Markdown
Member

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

Summary

  • Reorganize the English, 繁體中文 and API books into captioned, chapter-based toctrees (Getting Started → Reference) so readers can navigate by topic instead of a flat list.
  • Add a dedicated MCP Claude usage guide in both languages: server entry point, Claude Desktop and Claude Code configuration, in-conversation examples, full ~22-tool catalog, custom tool registration, and troubleshooting.
  • Also bundles the prior fix 5209aea Fix dir-existence check in executor template branch.

Test plan

  • python -m sphinx -b html docs/source docs/build/html --keep-goingbuild succeeded with no warnings.
  • Spot-check the rendered eng_index, zh_index, api_index and the new mcp_claude_doc pages on RTD once the build runs.
  • Confirm sidebar shows the 10 chapters in the configured order in both languages.

JE-Chen added 2 commits April 28, 2026 15:17
Both clauses checked keyword_dir_path; the executor branch should validate
its own directory. Harmless until now (both dirs are created together) but
the logic was wrong.
Split the English, 繁體中文 and API books into captioned chapters
(Getting Started, Core Wrappers, Actions, Backends, Reporting,
Orchestration, Quality, Tooling, Integrations, Reference) so readers
can navigate by topic instead of a flat list.

Add a dedicated mcp_claude page in both languages covering the MCP
server entry point, Claude Desktop and Claude Code configuration,
in-conversation usage examples, the full ~22-tool catalog, custom
tool registration and troubleshooting.

Hide the redundant toctree inside extended_features_doc so the same
subtopic pages do not produce duplicate-parent warnings while still
keeping the legacy hub link resolvable.
@codacy-production
Copy link
Copy Markdown

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

🟢 Metrics 0 complexity · 0 duplication

Metric Results
Complexity 0
Duplication 0

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 3df02b3 into main Apr 28, 2026
22 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