Documentation

[akshitadixit]

Issue
A clean and organised documentation of the project should be hosted on the gh-pages branch.

Required

• About the project
• Tech stack used
• Dependencies
• Explaining the project structure
• How to set up the project locally
• Deployment info

Additional context
Completing all checkpoints in a single PR isn't necessary.
Link

[Sakalya100]

Can I work on this issue?

[akshitadixit]

Sure @Sakalya100 :)

[Sakalya100]

@akshitadixit I have to make a readme file for this project right and the branch should be gh-pages?

[akshitadixit]

No @Sakalya100 you have to use the gh-pages branch and use the existing index.md file to add in one or more of the points mentioned above. Please visit the link given above to view the gh-pages deployment. For any assisstance, let me know.

[Sakalya100]

@akshitadixit Okay mam I will try to do it.

[Sakalya100]

@akshitadixit mam I am unable to find the index.md file in the codebase which you told me to use. Can you please tell me where to find index.md file

[akshitadixit]

Drop the mam.

The following commands could be of help:

• git switch gh-pages to switch to the github pages branch. When you do this, you should see index.md
• git switch main to switch back to main branch

If you do not fully understand this, drop a text in the #medicare channel on slack.

[Sakalya100]

Ok sure. I will try and in case of doubt I will drop a text

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs.