Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS]: Repeated step in README "Documentation" section. #1036

Open
chrisF943 opened this issue Jan 12, 2025 · 0 comments · May be fixed by #1040
Open

[DOCS]: Repeated step in README "Documentation" section. #1036

chrisF943 opened this issue Jan 12, 2025 · 0 comments · May be fixed by #1040
Labels
documentation Improvements or additions to documentation

Comments

@chrisF943
Copy link

Affected documentation section

"Documentation" section in README file

Documentation improvement description

Step 2 for Gemini setup under the "For Users" subsection in the "Documentation" section is repeated twice:

Gemini Setup

Follow the instructions below to ensure proper configuration of AIHawk with Ollama and Gemini.
Written by Rushi, Linkedin, support him by following.
Step 1: Get your free API key at https://aistudio.google.com/app/apikey.
Step 2: Verify Ollama is Running
Replace llm_api_key with your newly created API key on the file secrets.yaml located at Auto_Jobs_Applier_AIHawk\data_folder\secrets.yaml
Step 2: Verify Ollama is Running
Replace llm_api_key with your newly created API key on the file secrets.yaml located at Auto_Jobs_Applier_AIHawk\data_folder\secrets.yaml
Step 3: Edit Configuration in VS Code
Edit the file config.py located at Auto_Jobs_Applier_AIHawk\config.py with the following
llm_model_type: gemini
llm_model: 'gemini-pro'

Revision would be:

Gemini Setup

Follow the instructions below to ensure proper configuration of AIHawk with Ollama and Gemini.
Written by Rushi, Linkedin, support him by following.
Step 1: Get your free API key at https://aistudio.google.com/app/apikey.
Step 2: Verify Ollama is Running
Replace llm_api_key with your newly created API key on the file secrets.yaml located at Auto_Jobs_Applier_AIHawk\data_folder\secrets.yaml
Step 3: Edit Configuration in VS Code
Edit the file config.py located at Auto_Jobs_Applier_AIHawk\config.py with the following
llm_model_type: gemini
llm_model: 'gemini-pro'

Why is this change necessary?

Cleanup documentation, remove redundancy

Additional context

No response

@chrisF943 chrisF943 added the documentation Improvements or additions to documentation label Jan 12, 2025
@chrisF943 chrisF943 linked a pull request Jan 12, 2025 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant