Static Site Update: GitHub Pages

[yashksaini-coder]

✅ Fixes: #121

This pull request focuses on adding comprehensive documentation for the sneaky-package project, including contribution guidelines, installation instructions, usage examples, and an updated documentation site configuration.

Documentation Additions:

• docs/contributing.md: Added detailed contribution guidelines, including steps for setting up the development environment, identifying issues, making changes, and submitting contributions.
• docs/index.md: Created an index page to guide users through the documentation, including links to usage, installation, and contribution guidelines.
• docs/installation.md: Provided a complete installation guide, including prerequisites, installation steps, verification, and troubleshooting tips.
• docs/usage.md: Added usage instructions, including installation, basic usage, advanced features, and licensing information.

Documentation Site Configuration:

• mkdocs.yml: Configured the documentation site with a theme, navigation structure, and Markdown extensions for better readability and usability.

---

This is before:-

sneaky-package-Before.webm

AND after the MKdocs:-

sneaky-package-After.webm

---

Hi @this-is-yaash @jindalpriyanshu101 I have build the Documentation site with Github Pages deployment using MKDocs. Review this PR and add proper labels to it.

[yashksaini-coder]

@this-is-yaash can you review this PR, add proper labels to it.

[jindalpriyanshu101]

Hey @yashksaini-coder, its really impressive, but can't you use some minimalist kind of theme? as the current one feels a little bit over in terms of colors..

[yashksaini-coder]

Hey @yashksaini-coder, its really impressive, but can't you use some minimalist kind of theme? as the current one feels a little bit over in terms of colors..

yes I agree with you I was looking for github-dark theme, but for testing purposes this once was the best I could find on internet

[yashksaini-coder]

I will keep looking for the themes, and will share samples in the meantime @jindalpriyanshu101

[jindalpriyanshu101]

Well then, Everything looks good to me. However, changing theme to something blackish will be appreciated. Great Work tho. ;D

[this-is-yaash]

Everything is good.
We still have to update the home page (index.md)of the site.

Use your own approach to add contents in the home page and make a PR.
We'll get it merged!

[yashksaini-coder]

Everything is good. We still have to update the home page (index.md)of the site.

Use your own approach to add contents in the home page and make a PR. We'll get it merged!

Understood, let me cook

[ShashwatAgrawal20]

LGTM!

[yashksaini-coder]

@this-is-yaash check my forked version link now I have added new docs & changes the theme to dark style