docs: verify lazy exports, migrate deep imports, bring affected pages up to AGENTS.md spec (fixes #801)#802
Conversation
…S.md spec (fixes #801) B.1 — migrate deep imports to friendly form: - prompt-caching.mdx: two `from praisonaiagents.memory import Memory` → `from praisonaiagents import Memory` - hermes-openclaw-skills-import.mdx: `from praisonaiagents.tools import tool` → `from praisonaiagents import tool` - advanced-memory.mdx: `from praisonaiagents.agent.task import TaskOutput` → `from praisonaiagents import TaskOutput` B.2 — SDK sub-issue filed at MervinPraison/PraisonAI#2166 for register_memory_adapter, get_memory_adapter, list_memory_adapters C.1 — incremental-indexing.mdx: full rewrite with hero diagram, sequence diagram, Steps, IndexResult/CorpusStats/FileTracker config tables, AccordionGroup, CardGroup C.2 — knowledge-backends.mdx: add sidebarTitle, remove H1, add hero diagram, Steps, AccordionGroup, CardGroup C.3 — hermes-openclaw-skills-import.mdx: already AGENTS.md compliant; fixed deep import C.4 — skill-capability-gates.mdx: already fully compliant, no changes needed C.5 — advanced-memory.mdx: add sidebarTitle, remove H1, wrap Quick Start in Steps, convert Best Practices CardGroup → AccordionGroup, fix TaskOutput deep import, add Related CardGroup C.6 — resource-lifecycle.mdx: ChromaMemory() usage confirmed as factory function call (semantics correct); import from praisonaiagents is friendly-form and awaits SDK sync C.7 — workflow pages: - yaml-workflows.mdx: remove H1 - conditional-branching.mdx: add sidebarTitle - nested-workflows.mdx: add sidebarTitle - modular-recipes.mdx: add sidebarTitle, remove H1 - multi-agent-pipelines.mdx: add sidebarTitle, remove H1 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: MervinPraison <454862+MervinPraison@users.noreply.github.com>
Qodo reviews are paused for this user.Troubleshooting steps vary by plan Learn more → On a Teams plan? Using GitHub Enterprise Server, GitLab Self-Managed, or Bitbucket Data Center? |
|
Warning Review limit reached
More reviews will be available in 28 minutes and 59 seconds. Learn how PR review limits work. Your organization has used up its prepaid credits, and credit purchases are no longer available. Enable the review add-on in the billing tab to keep reviews running — you're only billed for reviews past your plan's rate limits ($0.25/file). ⌛ How to resolve this issue?After more reviews become available, a review can be triggered using the 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 credits. 🚦 How do rate limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan refill rate. For paid Pro and Pro+ PR reviews, CodeRabbit uses rolling per-developer review limits. Reviews become available again as older review attempts age out of the rolling limit window. Please see our Fair Usage Limits Policy for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (10)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates and standardizes the documentation across several features, including Advanced Memory, Incremental Indexing, and Knowledge Backends. Key changes include adding sidebar titles, simplifying Python imports in code snippets, restructuring guides using Steps and Accordion components, and adding Mermaid diagrams. The review feedback correctly identifies several critical errors in the documentation's code examples: the store_long_term method in advanced-memory.mdx incorrectly uses a 'memory' parameter instead of 'metadata', and multiple examples in incremental-indexing.mdx incorrectly pass a 'memory' dictionary to Knowledge.index() instead of passing 'user_id' directly. These mismatches would lead to runtime TypeErrors if copied by users.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
| memory.store_long_term( | ||
| text="Quantum computing uses qubits for computation", | ||
| completeness=0.95, # How complete is the information | ||
| relevance=0.90, # How relevant to the context | ||
| clarity=0.88, # How clear is the explanation | ||
| accuracy=0.92, # How accurate is the content | ||
| completeness=0.95, | ||
| relevance=0.90, | ||
| clarity=0.88, | ||
| accuracy=0.92, | ||
| memory={"user_id": "user123"} | ||
| ) |
There was a problem hiding this comment.
The store_long_term method of the Memory class accepts metadata as a parameter, not memory. Passing memory will result in a TypeError at runtime. Please update the parameter name to metadata.
memory.store_long_term(
text="Quantum computing uses qubits for computation",
completeness=0.95,
relevance=0.90,
clarity=0.88,
accuracy=0.92,
metadata={"user_id": "user123"}
)
| result = knowledge.index( | ||
| "./docs", | ||
| memory={"user_id": "my_user"}, | ||
| incremental=True, | ||
| ) |
There was a problem hiding this comment.
The Knowledge.index method accepts user_id directly as a keyword argument, not memory. Passing memory will result in a TypeError at runtime. Please update the parameter name to user_id.
result = knowledge.index(
"./docs",
user_id="my_user",
incremental=True,
)
|
|
||
| ## CLI Usage | ||
| knowledge = Knowledge() | ||
| result = knowledge.index("./docs", memory={"user_id": "alice"}) |
There was a problem hiding this comment.
The Knowledge.index method accepts user_id directly as a keyword argument, not memory. Passing memory will result in a TypeError at runtime. Please update the parameter name to user_id.
result = knowledge.index("./docs", user_id="alice")
| result = knowledge.index( | ||
| "./docs", | ||
| memory={"user_id": "alice"}, | ||
| force=True, | ||
| ) |
There was a problem hiding this comment.
The Knowledge.index method accepts user_id directly as a keyword argument, not memory. Passing memory will result in a TypeError at runtime. Please update the parameter name to user_id.
result = knowledge.index(
"./docs",
user_id="alice",
force=True,
)
| result = knowledge.index( | ||
| "./project", | ||
| memory={"user_id": "alice"}, | ||
| include_glob=["*.md", "*.txt", "*.py"], | ||
| exclude_glob=["*.log", "test_*", "__pycache__/*"], | ||
| ) |
There was a problem hiding this comment.
The Knowledge.index method accepts user_id directly as a keyword argument, not memory. Passing memory will result in a TypeError at runtime. Please update the parameter name to user_id.
result = knowledge.index(
"./project",
user_id="alice",
include_glob=["*.md", "*.txt", "*.py"],
exclude_glob=["*.log", "test_*", "__pycache__/*"],
)
|
|
||
| def load(self) -> None: | ||
| """Load state from file.""" | ||
| result = knowledge.index("./shared-docs", memory={"user_id": user_id}) |
There was a problem hiding this comment.
The Knowledge.index method accepts user_id directly as a keyword argument, not memory. Passing memory will result in a TypeError at runtime. Please update the parameter name to user_id.
result = knowledge.index("./shared-docs", user_id=user_id)
1 participant
Summary
from praisonaiagents.memory import Memorydeep imports inprompt-caching.mdxtofrom praisonaiagents import Memoryregister_memory_adapter,get_memory_adapter,list_memory_adaptersexports (custom-memory-adapters.mdx is blocked-on-SDK)incremental-indexing.mdx: hero Mermaid, sequence diagram, Steps Quick Start,IndexResult/CorpusStats/FileTrackerconfig tables,AccordionGroup, RelatedCardGroupknowledge-backends.mdx:sidebarTitle, remove H1, hero diagram,Steps,AccordionGroup,CardGrouphermes-openclaw-skills-import.mdx: fixfrom praisonaiagents.tools import tooldeep importskill-capability-gates.mdx: already AGENTS.md compliant, no changesadvanced-memory.mdx:sidebarTitle, remove H1,StepsQuick Start,AccordionGroupBest Practices, fixTaskOutputdeep import, RelatedCardGroupresource-lifecycle.mdx:ChromaMemory()confirmed as factory-function call (semantics correct)sidebarTitleto 4 pages, remove H1 from 3 pagesBlocked-on-SDK
docs/features/custom-memory-adapters.mdxdeep imports forregister_memory_adapter,get_memory_adapter,list_memory_adaptersare kept as-is pending MervinPraison/PraisonAI#2166.Files changed
docs/features/prompt-caching.mdxdocs/features/incremental-indexing.mdxdocs/features/knowledge-backends.mdxdocs/features/hermes-openclaw-skills-import.mdxdocs/features/advanced-memory.mdxdocs/features/resource-lifecycle.mdxdocs/features/conditional-branching.mdxdocs/features/nested-workflows.mdxdocs/features/modular-recipes.mdxdocs/features/yaml-workflows.mdxdocs/features/multi-agent-pipelines.mdxFixes #801
Generated with Claude Code