Add Detailed Setup Guide and Improve Documentation #70
+563
−120
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
zachary62
reviewed
Apr 30, 2025
| client = genai.Client( | ||
| api_key=os.getenv("GEMINI_API_KEY", "your-api_key"), | ||
| ) | ||
| 4. **Configure LLM access** |
There was a problem hiding this comment.
Maybe also mention something like: for other llm vendors or local llm, implement call_llm function that takes prompt string as input, and output the response string
|
|
||
| # Or, analyze a local directory |
There was a problem hiding this comment.
could you keep these just in readme? I love the detailed instructions! But having two files may be confusing. If the worry is that there are too many texts, we can try collapsible section in markdown to hide texts? https://gist.github.com/pierrejoubert73/902cc94d79424356a8d20be2b382e1ab
| @@ -1,7 +1,12 @@ | |||
| pocketflow>=0.0.1 | |||
There was a problem hiding this comment.
why pocketflow is removed?
|
This is very cool! Do you mind addressing the comments and resolve the conflicts? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR introduces a comprehensive SETUP.md file and improves the existing README.md to enhance the onboarding experience for new users and contributors.
Changes :
New SETUP.md: A detailed, step-by-step guide to help users install and configure the project quickly and correctly.
Updated README.md: Improved structure, clearer explanations, and links to the setup guide.