Static Site Update: GitHub Pages #129
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@yashksaini-coder everything is good, i'm satisfied with the outcome using mkdocs tool. We just have to change the theme(to smthng minimal) and update the contents in the docs, then we'll be all set🚀 |
this-is-yaash
requested review from
jindalpriyanshu101,
Wahid7852,
ShashwatAgrawal20 and
this-is-yaash
this-is-yaash
added
documentation
this-is-yaash
changed the title
this-is-yaash
added
level2
|
@this-is-yaash hi closed this PR by accident, created new one #132 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
✅ Fixes: #121
This pull request focuses on adding comprehensive documentation for the
sneaky-packageproject, 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.