[fengju0213]

This PR adds a release-driven incremental docs sync flow for Mintlify documentation. It introduces doc_code_map-based impact detection, a ChatAgent-based updater that edits one impacted doc at a time, and a GitHub Actions workflow that opens an automated docs PR when mapped pages actually change.

It also adds doc_code_map coverage across key docs/mintlify/key_modules and docs/mintlify/mcp pages, refreshes several docs to match current APIs, and fixes malformed or stale examples in the affected pages.

What Changed

Release docs auto-sync tooling

• Added .github/workflows/docs_release_auto_sync_pr.yml to run on release publication, verify doc_code_map, compute changed Python files, resolve impacted docs, run the ChatAgent updater, and create a PR only when docs actually changed.
• Added docs/mintlify/scripts/docs_sync/doc_code_map.py and docs/mintlify/scripts/docs_sync/README.md to validate frontmatter mappings and compute impacted docs from changed Python files or git refs.
• Added .camel/skills/docs-incremental-update/SKILL.md and .camel/skills/docs-incremental-update/scripts/auto_sync_docs_with_chatagent.py to define the incremental docs update workflow and execute it through CAMEL.

Agent execution and scoping rules

• The updater processes one target doc at a time and keeps edits scoped to that file.
• Workflow success is based on actual target doc diffs rather than special sentinel text in the model response.
• Added focused coverage in test/docs/test_docs_sync.py for impact detection, changed-file handling, prompt construction, and response logging.

doc_code_map coverage for Mintlify docs

• Added doc_code_map frontmatter to key module pages covering areas such as agents, benchmarks, browser toolkit, datagen, embeddings, interpreters, loaders, memory, messages, models, prompts, retrievers, runtimes, societies, storages, tasks, terminal toolkit, tools, and workforce.
• Added doc_code_map frontmatter to MCP pages including camel_agents_as_an_mcp_clients, camel_toolkits_as_an_mcp_server, connecting_existing_mcp_tools, export_camel_agent_as_mcp_server, mcp_hub, and overview.

Documentation updates and example fixes

• Updated docs/mintlify/key_modules/runtimes.mdx to clean up content and correct the examples/runtimes link.
• Updated docs/mintlify/key_modules/terminaltoolkit.mdx to document managed runtime environments, optional Go/Java runtime support, safe mode behavior, and human-in-the-loop session handling.
• Updated docs/mintlify/key_modules/workforce.mdx to cover pipeline mode, failure handling config, runtime control APIs, workflow memory, and current ModelFactory usage.
• Updated docs/mintlify/key_modules/storages.mdx to fix the SurrealStorage import and improve storage examples.
• Updated docs/mintlify/mcp/camel_agents_as_an_mcp_clients.mdx and docs/mintlify/mcp/export_camel_agent_as_mcp_server.mdx to align MCP examples with current imports and usage patterns.
• Fixed malformed or stale snippets in docs/mintlify/key_modules/loaders.mdx, docs/mintlify/key_modules/tools.mdx, and docs/mintlify/key_modules/interpreters.mdx.

Closes #

Description

What is the purpose of this pull request?

• Bug fix
• New Feature
• Documentation update
• Other

Checklist

• I have read and agree to the AI-Generated Code Policy (required)
• I have linked this PR to an issue (required)
• I have checked if any dependencies need to be added or updated in pyproject.toml and run uv lock
• I have updated the tests accordingly (required for a bug fix or a new feature)
• I have updated the documentation if needed
• I have added examples if this is a new feature

If you are unsure about any of these, don't hesitate to ask. We are here to help!

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 69c9a252-28d4-49df-8130-fd00b9fcb1d4

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

• 🔍 Trigger review

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch camel_doc

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

Tip

You can disable poems in the walkthrough.

Disable the reviews.poem setting to disable the poems in the walkthrough.

[claude]

⚠️ Code review skipped — your organization's overage spend limit has been reached.

Code review is billed via overage credits. To resume reviews, an organization admin can raise the monthly limit in Settings → Usage.

Once credits are available, reopen this pull request to trigger a review.

[a7m-1st]

Thanks for the PR @fengju0213 ; I have reviewed almost all elements except testing the auto sync on PR itself. Perhaps we can have a go at that after we merge?

Left a comment below on a small bug perhaps you can fix it; Also updated the terminal to look return more context on missing commands:

Before

After

[fengju0213]

Thanks for the PR @fengju0213 ; I have reviewed almost all elements except testing the auto sync on PR itself. Perhaps we can have a go at that after we merge?

Left a comment below on a small bug perhaps you can fix it; Also updated the terminal to look return more context on missing commands:

Before

After

thanks @a7m-1st fixed

[Wendong-Fan]

overall LGTM, added some minor enhance in #3955