docs: Add a comprehensive FAQ section to improve user and contributor onboarding

[PalashKulkarni]

Description

Summary

The project currently has detailed setup and contribution guides, but there is no centralized FAQ section to address common questions from users and first-time contributors.

Adding a dedicated FAQ section (either in the README.md or as a separate docs/faq.md file) would improve the onboarding experience and reduce repetitive queries.

Proposed Content

The FAQ could include answers to questions such as:

• What is DevPath and who is it for?
• How does the recommendation engine work?
• How can I add a new project to the dataset?
• Why am I not getting any recommendations?
• How do I run the project locally?
• How can I contribute as a first-time open-source contributor?
• How do I run the test suite?
• Where can I report bugs or request new features?

Expected Outcome

• A well-organized FAQ section covering common user and contributor questions.
• Improved documentation and onboarding experience.
• Reduced confusion for new contributors and users.

Difficulty

Beginner-friendly

Labels

documentation good first issue

[github-actions]

Thank you for opening your first issue in DevPath.

Please make sure to:

• Read CONTRIBUTING.md
• Wait for assignment before starting work
• Follow repository guidelines carefully

Happy contributing.

[PalashKulkarni]

@komalharshita , I would like to work on this issue, can you please assign it to me ?
Thanking you in advance
Palash Kulkarni

[ADITYAKUSHWAHA7975]

/assign

[Laxmi928]

Hi @komalharshita ,

I would like to work on this issue under GSSoC '26.

I have reviewed the project documentation and would like to contribute by creating a dedicated FAQ section covering common questions related to project usage, recommendations, setup, testing, and contribution guidelines.

I will ensure the FAQ is well-structured, beginner-friendly, and aligned with the existing documentation style to improve the onboarding experience for both users and contributors.

Kindly assign this issue to me.

Thank you!

[NirvanJain]

Heyy @Laxmi928
I would like to work on this issue under GSSoC 2026.
I have prior experience with open-source contributions and would be happy to work on this issue. Please assign it to me.
Thank you!

[riyantium]

Hi @komalharshita ,

I'd like to work on this issue under GSSoC. I plan to create a clear and organized FAQ section covering common user and contributor questions while ensuring it aligns with the existing documentation and project structure.

Could you please assign this issue to me? Thank you!