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]: Unclear what to do with unneeded options in YAML files #899

Open
kttn opened this issue Nov 21, 2024 · 2 comments
Open

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

kttn opened this issue Nov 21, 2024 · 2 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@kttn
Copy link

kttn commented Nov 21, 2024

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: "work_preferences.yaml" and "plain_text_resume.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

@kttn kttn added the documentation Improvements or additions to documentation label Nov 21, 2024
@surapuramakhil surapuramakhil added the good first issue Good for newcomers label Nov 21, 2024
@surapuramakhil
Copy link
Contributor

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

@kttn
Copy link
Author

kttn commented Nov 22, 2024

@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.

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 good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants