docs: improve developer setup guide with troubleshooting and OS-specific prerequisites#68
Open
HritikRaj2 wants to merge 1 commit intohyphae:add-license-1from
Open
Conversation
…fic prerequisites Signed-off-by: Hritik Raj <hritik23154049@akgec.ac.in>
HritikRaj2
force-pushed
the
improve-developer-setup
branch
from
04f4a1b to
5a009a9
Compare
Author
|
Hi @axmsoftware @AkarshSahlot! This PR adds troubleshooting guides and OS-specific setup instructions to help new contributors get started faster. Would appreciate your review when you have time. Thanks! |
axmsoftware
approved these changes
Jan 6, 2026
Contributor
axmsoftware
left a comment
axmsoftware
left a comment
There was a problem hiding this comment.
@HritikRaj2 Thank you for the detailed documentation of the PR and the added features for the README.me file!
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Closes #66
Summary
This PR addresses the developer onboarding issues identified in #66 by improving the README documentation with comprehensive setup guidance.
Changes Made
1. Expanded Troubleshooting Section
2. Enhanced Prerequisites Section
3. Added Quick Component Reference Table
Impact
✅ New contributors can set up the project on any major OS
✅ Reduces support burden with comprehensive troubleshooting
✅ Faster onboarding with clear component explanations
✅ Fewer setup-related issues and questions
Testing
Related Issues
Addresses all documentation concerns raised in #66: