Update Project Usage Documentation

[smaranjitghose]

NOTE: This is an issue that exclusively demands knowledge of Python. Please take this up only if you are comfortable beyond basics

Package to be used: MkDocs Material

Branch for source code: documentation

Please read through the documentation carefully and dedicate some time!

Documentation Requirements:

1. Welcome [Refer the readme]

   • About the project
   • Why Open Source?
   • Programs we have been a part of
   • Sneak Peak (Use Gifs)
   • Team

   ** Please do beyond just copy-paste. Use your creative writing skills.

   2. How to start using it?
      • Install Git
      • Setup Git and GitHub Account
      • Navigate to GitHub Repository
      • Fork the repo
      • Clone the repo [ use git clone ..... --depth 1]
      • Access the local copy
      • Delete Additional Stuff ( Readme, Readme assets,etc)
   3. Page by Page Changes:
      • Home Page
      • Education Page
      • Project Page
      • Experience Page
      • Research Page
      • Social Media Links
      • Assets
      • SEO

   ^^ Detailed guide on which files to open, where to change the content and for what parts? Use screenshots of the changes!

   4. Publishing the portfolio!
      • Save the changes
      • The step by step to push to Github
      • Tip: On making the repository private if desired
      • Deployment + Using Custom Domain:
        • GitHub Pages
        • Netlify
        • AWS Amplify

Directions:

• Some of the content is already there. We expect you to improve it in any or all ways possible!
• Please take only one page at a time to update and state it clearly in the comments below
• First, update the source code, check your build output, push to your own gh-pages branch
• Then in the PR, compare both the documentation and gh-pages branch (separate PRs but would be counted as a pair)
• Attach a screenshot of your changes
• Attach a link to your own deploy preview on GitHub pages
• Use proper comments in the markdown files

[lavakush07]

"I want to work on this issue under JWOC"

[anushbhatia]

@lavakush07 do give regular updates here and if you face issues ask @smaranjitghose

[lavakush07]

@lavakush07 do give regular updates here and if you face issues ask @smaranjitghose

Yeah sure..

[smaranjitghose]

@lavakush07 Updates?