Fix #2: Readme File Issue (Project Documentation)

[musangamfure]

Fix #2

In this PR, I worked on improving project documentation by updating the README.md file with comprehensive information about KlinicCon. The changes include:

• added table of content
• Draft initial sections of the project which may keep changing depending on the need
• Improved overall formatting and structure for better readability

These changes are provisional especially contents of each section. I will keep updating it as we progress.

Thanks.

Please Review my changes and let me know your suggestions and comments

Happy coding 💪🥳

[rt4914]

Couple of suggestions before I check the documentation fully:

1. Have a look at point 6,7 in here https://github.com/rt4914/KlinicCon-Backend/wiki#creating-a-pull-request. Using that add me as reviewer and as assignee.
2. Assignee section should basically point to the person who should take action on this PR, if it is assigned to me, that means I have to review it. If it is assigned to you that means you have to take some actions on the PR.
3. There are some un-intentional changes in Gemlock and database file. Add these files to gitignore so that these changes are not visible in the pull request files section.

[rt4914]

@musangamfure Please don't resolve comments on your own. The person who has started the comment-thread will verify it based on your response and then resolve it. You just make sure that you reply to all the comments and once PR is ready for review, assign it to the person who needs to review/check it.

[musangamfure]

I am very sorry for my mistakes, I will not do it again. Actually I didn't know what it really means to resolve comments.

On Tue, Aug 6, 2024, 10:17 AM Rajat Talesra @.***> wrote:

@musangamfure https://github.com/musangamfure Please don't resolve comments on your own. The person who has started the comment-thread will verify it based on your response and then resolve it. You just make sure that you reply to all the comments and once PR is ready for review, assign it to the person who needs to review/check it.

— Reply to this email directly, view it on GitHub https://github.com/rt4914/KlinicCon-Backend/pull/10#issuecomment-2270664757, or unsubscribe https://github.com/notifications/unsubscribe-auth/A5LZGUCPGWDUNQGBRB53HDLZQCBARAVCNFSM6AAAAABL5JMSFOVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDENZQGY3DINZVG4 . You are receiving this because you were mentioned.Message ID: @.***>

[rt4914]

I am very sorry for my mistakes, I will not do it again. Actually I didn't know what it really means to resolve comments. … On Tue, Aug 6, 2024, 10:17 AM Rajat Talesra @.> wrote: @musangamfure https://github.com/musangamfure Please don't resolve comments on your own. The person who has started the comment-thread will verify it based on your response and then resolve it. You just make sure that you reply to all the comments and once PR is ready for review, assign it to the person who needs to review/check it. — Reply to this email directly, view it on GitHub <#10 (comment)>, or unsubscribe https://github.com/notifications/unsubscribe-auth/A5LZGUCPGWDUNQGBRB53HDLZQCBARAVCNFSM6AAAAABL5JMSFOVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDENZQGY3DINZVG4 . You are receiving this because you were mentioned.Message ID: @.>

@musangamfure Don't worry. If didn't knew and its fine. I am here to guide. Don't worry about these things just learn from these.

[musangamfure]

Thank you Sir. I am here to learn and grow from you.

On Tue, Aug 6, 2024, 11:38 AM Rajat Talesra @.***> wrote:

I am very sorry for my mistakes, I will not do it again. Actually I didn't know what it really means to resolve comments. … <#m-6424002345219664512> On Tue, Aug 6, 2024, 10:17 AM Rajat Talesra @.> wrote: @musangamfure https://github.com/musangamfure https://github.com/musangamfure https://github.com/musangamfure Please don't resolve comments on your own. The person who has started the comment-thread will verify it based on your response and then resolve it. You just make sure that you reply to all the comments and once PR is ready for review, assign it to the person who needs to review/check it. — Reply to this email directly, view it on GitHub <#10 (comment) https://github.com/rt4914/KlinicCon-Backend/pull/10#issuecomment-2270664757>, or unsubscribe https://github.com/notifications/unsubscribe-auth/A5LZGUCPGWDUNQGBRB53HDLZQCBARAVCNFSM6AAAAABL5JMSFOVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDENZQGY3DINZVG4 https://github.com/notifications/unsubscribe-auth/A5LZGUCPGWDUNQGBRB53HDLZQCBARAVCNFSM6AAAAABL5JMSFOVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDENZQGY3DINZVG4 . You are receiving this because you were mentioned.Message ID: @.>

@musangamfure https://github.com/musangamfure Don't worry. If didn't knew and its fine. I am here to guide. Don't worry about these things just learn from these.

— Reply to this email directly, view it on GitHub https://github.com/rt4914/KlinicCon-Backend/pull/10#issuecomment-2270839830, or unsubscribe https://github.com/notifications/unsubscribe-auth/A5LZGUHUK6GLP7R66FYD35DZQCKP3AVCNFSM6AAAAABL5JMSFOVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDENZQHAZTSOBTGA . You are receiving this because you were mentioned.Message ID: @.***>

[rt4914]

@musangamfure Last update on this PR was 4-days ago. Any idea when can you update this?

[musangamfure]

I have worked on the requested changes. You can review them and let me know what to do next

[rt4914]

@musangamfure Any update on this?

[musangamfure]

I have made the changes you mentioned. but I am not able to revert the changes from Gemfile. lock. Please help me to know how