Improve Documentation on RAG Framework Capability

[sandijean90]

Summary

The BeeAI framework has RAG capabilities that can be showcased and explained more clearly it the documentation. This is a good first issue for contributors who are interested in enhancing documentation.

Success Criteria

• [ ] Documentation updated https://framework.beeai.dev/modules/rag

Helpful Instructions for working with mintlify and mise

Mintlify for updating docs:

• Make sure you have Node.js version 19 or higher
• cd to the docs folder in the repo. As long as it has a package.json you can run “npm install” and it will install the same version of mintlify as what is being used in the repo.
• run “npx mintlify dev” to spin up a preview of the docs in your browser. Default is on port 3000 http://localhost:3000/. The development server will watch for changes to your .mdx files and any edits you make will automatically refresh in the browser

Using mise to update embedded code in docs:

• go to the root of the repo cd ~/beeai-framework and run “mise docs:fix:snippets”

Embedded docs format for mise to add on top of empty code snippet:

  {/* <!-- embedme python/examples/agents/react.py --> */}
  
  ```py Python [expandable]
  
  ```

using mise to update packages and keep things synced:

• run “mise install” at the repo level
• note: treat this like uv sync. run it whenever you want to make sure your packages are updated and aligned with main.

[patelaryan66]

I'd like to give this a try

[sandijean90]

@patelaryan66 looking forward to seeing your first contribution!

[dosubot[bot]]

Hi, @sandijean90. I'm Dosu, and I'm helping the beeai-framework team manage their backlog and am marking this issue as stale.

Issue Summary

• You requested clearer and more comprehensive documentation for BeeAI's RAG capabilities aimed at first-time contributors.
• The issue includes detailed guidance on using Mintlify and Mise tools for updating and previewing docs at https://framework.beeai.dev/modules/rag.
• There has been positive engagement, with user patelaryan66 expressing interest in contributing and you encouraging them.
• The issue remains unresolved with no recent updates or progress reported.

Next Steps

• Please let me know if this issue is still relevant to the latest version of the beeai-framework repository by commenting here to keep the discussion open.
• If I do not hear back within 7 days, I will automatically close this issue.

Thank you for your understanding and contribution!

[sandijean90]

This issue is still relevant.