Create Documentation Folder and Webpage

[prabhashj07]

Description:

We need to enhance the documentation for NepaliKit by creating a dedicated docs folder in the repository and setting up a documentation webpage. This will help users understand and utilize the library more effectively by providing detailed usage guidelines, examples, and explanations for each feature.

---

Checklist:

• Create Documentation Folder:

  • Add a docs directory to the repository.
  • Set up subfolders within docs for different sections, such as:
    • usage: Installation and basic usage instructions.
    • examples: Code examples demonstrating feature usage.
    • features: Detailed explanations of each feature.
    • api_reference: API reference guide with function definitions and parameters.

• Set Up Documentation Webpage:

  • Choose a documentation tool (e.g., GitHub Pages, Read the Docs, MkDocs).
  • Set up the webpage with:
    • Navigation menus for easy access to different documentation sections.
    • Search functionality to help users find relevant information.
  • Link the documentation folder to the webpage.

• Content to Include:

  • Usage Guidelines:
    • Installation instructions.
    • Basic usage examples.
  • Detailed Examples:
    • Code snippets demonstrating library features.
  • Feature Explanations:
    • In-depth explanations of library features and their parameters.
  • API Reference:
    • Comprehensive guide for the library’s API.

• Additional Notes:

  • Provide guidelines for contributing to the documentation.
  • Ensure the documentation is kept up-to-date with new features and changes.

---

Additional Comments:

Please highlight any areas of the documentation that currently lack detail or are missing entirely. If you have any suggestions for the documentation tool or format, include them here.