AIHawk-FOSS / Auto_Jobs_Applier_AI_Agent

Auto_Jobs_Applier_AI_Agent by AIHawk is an AI Agent that automates the jobs application process. Utilizing artificial intelligence, it enables users to apply for multiple jobs in an automated and personalized way.
GNU Affero General Public License v3.0
22.54k stars 3.34k forks source link

[DOCS]: Unclear what to do with unneeded options in YAML files #899

Open kttn opened 6 days ago

kttn commented 6 days ago

Affected documentation section

  1. work_preferences.yaml; 3. plain_text_resume.yaml

Documentation improvement description

I am unclear as to what I should be doing with unneeded options in the two YAML Files: _"workpreferences.yaml" and _"plain_textresume.yaml".

For example, plain_text_resume.yaml, in the personal_information section :

personal_information:
  name: "[Your Name]"
  surname: "[Your Surname]"
  date_of_birth: "[Your Date of Birth]"
  country: "[Your Country]"
  city: "[Your City]"
  address: "[Your Address]"
  zip_code: "[Your zip code]"
  phone_prefix: "[Your Phone Prefix]"
  phone: "[Your Phone Number]"
  email: "[Your Email Address]"
  github: "[Your GitHub Profile URL]"               # Un-needed (Github profile, in my case, is not required, and would be odd to include)
  linkedin: "[Your LinkedIn Profile URL]"

What do I do to omit the inclusion of the GitHub Profile URL field/option?

Can I just comment out the ones I don't need?

Can they just be removed, without affecting the main program logic?

Can I mark them with something like n/a, and they AI will figure out what to do?

I may have missed something, but this is unclear to me!

Why is this change necessary?

If not included, and I haven't missed it, including this information will make the project more accessible to a larger audience

Additional context

No response

surapuramakhil commented 6 days ago

@kttn have you tried moving it? does it throw config validation error?

kttn commented 5 days ago

@surapuramakhil I have not been able to actually run the bot yet, as I am still configuring, and I also have to wait to get an AI subscription. I can give you more information once I have started running.