Skip to content

updated README - #144

Open
vighnesh-xi wants to merge 1 commit into
The-Pocket:mainfrom
vighnesh-xi:main
Open

updated README#144
vighnesh-xi wants to merge 1 commit into
The-Pocket:mainfrom
vighnesh-xi:main

Conversation

@vighnesh-xi

Copy link
Copy Markdown

Summary

Improved the PocketFlow RAG tutorial to make the offline and online stages clearer, and made the run instructions easier to follow.

What changed

  • Clarified the difference between the offline indexing stage and the online question-answering stage.
  • Added simpler explanations for each node in the flow.
  • Improved the notes around how PocketFlow separates document preparation from question answering.
  • Cleaned up the run instructions and the example explanation.

Why

The previous README was a bit hard to follow for first-time users. This version makes the tutorial easier to understand, especially for readers trying to learn how PocketFlow structures a RAG pipeline.

Testing

  • Reviewed the tutorial text for clarity and flow.
  • Verified the updated explanation matches the PocketFlow RAG design pattern.

Notes

  • This is a documentation-only change.

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