Skip to content

docs(integrations): add copy-paste recipes for LlamaIndex/CrewAI/Auto… - #65

Open
popwatt wants to merge 2 commits into
afx-team:mainfrom
popwatt:docs/framework-integrations
Open

docs(integrations): add copy-paste recipes for LlamaIndex/CrewAI/Auto…#65
popwatt wants to merge 2 commits into
afx-team:mainfrom
popwatt:docs/framework-integrations

Conversation

@popwatt

@popwatt popwatt commented Aug 11, 2026

Copy link
Copy Markdown

…Gen/LangGraph

Summary

Motivation

Checklist

  • Tests added or updated (pytest tests/ -v)
  • Documentation updated (repo_pages/, docstrings, or README) if user-facing
  • CHANGELOG.md updated under ## [Unreleased]
  • ruff check src/ passes
  • mypy src/hebb/ passes (project uses strict = true)
  • No secrets, credentials, or local config files committed

Notes for reviewers

Summary by CodeRabbit

  • Documentation
    • Added a Python framework integrations guide for LlamaIndex, CrewAI, AutoGen, and LangGraph.
    • Included setup instructions, MCP and REST usage, installation commands, runnable examples, and integration guidance.
    • Added Chinese-language documentation covering the same integrations and compatibility details.
    • Linked the new guide from the README, examples documentation, and bilingual documentation navigation.

@coderabbitai

coderabbitai Bot commented Aug 11, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@popwatt, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 45 minutes

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: def3bd17-cd7d-4a40-9271-e0e4bd39b055

📥 Commits

Reviewing files that changed from the base of the PR and between 1192eec and ab10dc4.

📒 Files selected for processing (2)
  • repo_pages/guide/framework-integrations.md
  • repo_pages/zh/guide/framework-integrations.md
📝 Walkthrough

Walkthrough

Added a bilingual Python Framework Integrations guide. It documents MCP and REST integration with LlamaIndex, CrewAI, AutoGen 0.4+, and LangGraph. Repository README files and the VitePress sidebar now link to the guide.

Changes

Framework integrations

Layer / File(s) Summary
Guide foundation
repo_pages/guide/framework-integrations.md, repo_pages/zh/guide/framework-integrations.md
Added service setup, supported MCP tools, REST endpoints, health checks, executable-path guidance, and LLM prerequisites.
Framework MCP examples
repo_pages/guide/framework-integrations.md, repo_pages/zh/guide/framework-integrations.md
Added MCP examples for LlamaIndex, CrewAI, AutoGen 0.4+, and LangGraph.
REST alternatives and architecture
repo_pages/guide/framework-integrations.md, repo_pages/zh/guide/framework-integrations.md
Added REST memory helpers, MCP-versus-REST selection guidance, and architecture diagrams.
Documentation navigation
README.md, examples/README.md, repo_pages/.vitepress/config.mts
Added guide links and a bilingual sidebar entry.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related issues

Possibly related PRs

  • afx-team/hebb-mind#62 — Covers the same framework-integration documentation, navigation links, and bilingual guide pages.

Suggested reviewers: afx-team, ch-liuzhide

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly identifies the documentation change and names the primary framework integrations covered by the copy-paste recipes.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

Comment @coderabbitai help to get the list of available commands.

@popwatt

popwatt commented Aug 11, 2026

Copy link
Copy Markdown
Author

#29

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 6

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@repo_pages/guide/framework-integrations.md`:
- Around line 36-37: Update the “The agent needs an LLM” tip in the framework
integrations guide to exclude the LlamaIndex snippet, since it directly calls
search.acall without creating an LLM client. State that only the snippets using
an LLM require one, while preserving the existing OpenAI-compatible and
local-model guidance and the LlamaIndex no-key clarification.
- Around line 26-28: Update the curl readiness-check command for the POST search
request to include --fail-with-body (or -f), so HTTP 4xx/5xx responses produce a
failure while preserving the existing request and response body behavior.

In `@repo_pages/zh/guide/framework-integrations.md`:
- Around line 26-28: Update the curl readiness-check command in the framework
integrations guide to include -f or --fail-with-body, ensuring HTTP 4xx and 5xx
responses produce a failure while preserving the existing request options.
- Line 65: Translate all natural-language content in the Chinese document,
including the search query near search.acall and the role, goal, backstory, task
descriptions, expected output, and user prompts at the referenced sections. Keep
framework names, package names, API identifiers, and code syntax unchanged, and
ensure no English prose remains mixed into the Chinese page.
- Around line 36-37: Update the prerequisite text in the 智能体需要一个 LLM tip to
exclude the LlamaIndex snippet, stating that only the snippets that invoke an
LLM require one. Preserve the existing provider examples and framework-specific
documentation reference.
- Around line 183-186: Update the REST API example near the httpx import to
explicitly instruct readers to install the HTTP client in the environment
running the framework code, adding the command pip install httpx before the
example.
🪄 Autofix

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 66be59ca-93d7-4d51-a566-78bd41130420

📥 Commits

Reviewing files that changed from the base of the PR and between 36ce983 and 1192eec.

📒 Files selected for processing (5)
  • README.md
  • examples/README.md
  • repo_pages/.vitepress/config.mts
  • repo_pages/guide/framework-integrations.md
  • repo_pages/zh/guide/framework-integrations.md

Comment thread repo_pages/guide/framework-integrations.md Outdated
Comment thread repo_pages/guide/framework-integrations.md Outdated
Comment thread repo_pages/zh/guide/framework-integrations.md Outdated
Comment thread repo_pages/zh/guide/framework-integrations.md Outdated
Comment thread repo_pages/zh/guide/framework-integrations.md Outdated
Comment thread repo_pages/zh/guide/framework-integrations.md Outdated
…ns guide

- make the curl readiness check fail on HTTP 4xx/5xx (-f)
- scope the LLM prerequisite tip to the agent snippets; LlamaIndex direct-call example needs no LLM key
- translate natural-language strings in the zh page code snippets (queries, agent metadata, prompts); keep API identifiers unchanged
- add explicit pip install httpx before the REST example (EN + zh parity)

Closes afx-team#29
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