Improve Documentation for Better Contributor Onboarding

[ajaynegi45]

Description:

The current documentation for the Http-Server project lacks clarity in certain areas, making it difficult for new contributors to understand the codebase and contribute effectively. This issue involves updating and enhancing the existing documentation to improve the contributor experience.

Tasks:

• Review the existing documentation and identify areas that need improvement.
• Add detailed explanations of key features and modules within the project.
• Ensure proper formatting and structure for easy navigation.
• Include steps for setting up the development environment and running the project locally.
• Create guidelines on how to contribute (pull request process, coding standards, etc.).

Expected Outcome:

• The documentation should be comprehensive and easy to follow for new contributors.
• Contributors should be able to understand the project's structure, code logic, and contribution process without confusion.

[pchy-ynda]

Hello, I'm interested in taking this task. Is about enhancing the contributing.md file? Is it currently being worked on by someone else already?

[ajaynegi45]

Hello, I'm interested in taking this task. Is about enhancing the contributing.md file? Is it currently being worked on by someone else already?

Hello! @pchy-ynda, the task involves improving both the README.md and CONTRIBUTING.md files to make onboarding easier for contributors. No one is currently working on this issue, so feel free to start working and if you have any questions or need assistance during the process, please don't hesitate to reach out.

[pchy-ynda]

Yes, may I have your Discord username to DM you the details?

[ajaynegi45]

Yes, may I have your Discord username to DM you the details?

ajaynegi. (make sure to add dot atlast)

[pchy-ynda]

Mine is yolaegi. I just sent you my friend request on Discord.

…

On Sat, 5 Oct 2024 at 8:30 pm, Ajay Negi ***@***.***> wrote: Yes, may I have your Discord username to DM you the details? ajaynegi. (make sure to add dot atlast) — Reply to this email directly, view it on GitHub <#1 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/BCHZDFC4PV2OYVBRAYI3G5TZ2A445AVCNFSM6AAAAABPB3JZS2VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDGOJVGE3DMNZRGI> . You are receiving this because you were assigned.Message ID: ***@***.***>

[ajaynegi45]

Mine is yolaegi. I just sent you my friend request on Discord.
…
On Sat, 5 Oct 2024 at 8:30 pm, Ajay Negi @.> wrote: Yes, may I have your Discord username to DM you the details? ajaynegi. (make sure to add dot atlast) — Reply to this email directly, view it on GitHub <#1 (comment)>, or unsubscribe https://github.com/notifications/unsubscribe-auth/BCHZDFC4PV2OYVBRAYI3G5TZ2A445AVCNFSM6AAAAABPB3JZS2VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDGOJVGE3DMNZRGI . You are receiving this because you were assigned.Message ID: @.>

did not get any friend request.

[aditya76-webdev]

Hey @ajaynegi45 i think there's no updation in this issue and no one is working so can i get this issue i will try to update the documentation? what do you say ?