Documentation: GitHub Page

[iamyaash]

Share your ideas and thoughts here!

[iamyaash]

We already have documentation for:

• how_to_use_package.md – how to use this package (execution)
• contributing.md – contributor guidelines
• PyPi_Setup.md – setting up the package globally

We are planning to integrate these into the GitHub page, but they will act as redirected pages.

The task is to write general documentation for the home page, and we can use these existing docs as redirects.

[yashksaini-coder]

@this-is-yaash

Then creating a dedicated docs/ directory that will hold all the files for the documentation.
Each section of the documentation can be broken into individual Markdown files (e.g., installation.md, usage.md, faq.md).

Can use Mkdocs or docsaurus or Jekyll with minima to render the HTML

Create the main Home and adding nav links to all the other md files.

[iamyaash]

great! just one questn
are those flexible enough to make changes easily in future?

i want to ensure that it will be simple to update the documentation as the project evolves

[yashksaini-coder]

yeah MKdocs & docsaurus are flexible as they only need changes in README

[iamyaash]

alright!
@yashksaini-coder leave a comment in #121
I'll assign it to you!