revamp and renew the readme according to most recent project updates#88
revamp and renew the readme according to most recent project updates#88yuvalk wants to merge 3 commits intoredhat-community-ai-tools:mainfrom
Conversation
Replace the onboarding-oriented README with a comprehensive technical reference covering architecture diagram, setup instructions for all four components, infrastructure prerequisites, configuration variables, deployment guide, testing, and project structure. Fixes broken placeholder link and adds missing RAG module documentation. Co-Authored-By: Claude Opus 4.6 (1M context) <[email protected]>
…oals Bring back the welcoming onboarding style from the original README (intro greeting, project goals, emoji headings, final words section) while retaining all the new technical content added in the previous commit. Co-Authored-By: Claude Opus 4.6 (1M context) <[email protected]>
README.md
Outdated
| ### 3. 🖥️ Graphical User Interface (GUI) | ||
| ## 🚀 Getting Started | ||
|
|
||
| ### Backend (Data Pipeline Hub) |
There was a problem hiding this comment.
though the BE folder exists it's not used and is replaced with the newer rag folder/app
we'll remove it so it will not make your content inaccurate.
in addition the naming dataflow will be removed from the code entirely.
|
|
||
| 📘 Reference Documentation: | ||
| 👉 [`Agentic AI README`](LINK 2) | ||
| Start MongoDB, RabbitMQ, and Qdrant: |
There was a problem hiding this comment.
Did you by any chance try this procedure to make sure it works properly with these commands/steps?
There was a problem hiding this comment.
● No, I didn't verify any of the setup commands. I pulled them from the existing component READMEs and config files, but didn't actually run them to confirm
they work. The docker commands, pip installs, celery worker invocations, and pnpm commands are all untested.
Would you like me to verify any specific section?
|
@yuvalk thanks for the updates this really helps! was this review done by hand or by an agent (if an agent I'd appreciate the details including the prompt so I can re run again to see the output as well) |
|
let me address your comments :)
I think I just asked Claude something like |
…service Co-Authored-By: Claude Opus 4.6 (1M context) <[email protected]>
|
Important Review skippedReview was skipped due to path filters ⛔ Files ignored due to path filters (1)
CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing touches🧪 Generate unit tests (beta)
Tip Issue Planner is now in beta. Read the docs and try it out! Share your feedback on Discord. 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 |
2 participants
the old readme is already outdated