-
Notifications
You must be signed in to change notification settings - Fork 64
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or requestgood first issueGood for newcomersGood for newcomershacktoberfesthelp wantedExtra attention is neededExtra attention is needed
Description
Is your feature request related to a problem? Please describe.
Our current documentation is too large and detailed to be effectively maintained in the README.md. This makes it harder for users to navigate and find the information they need.
Describe the solution you'd like
Move the documentation to a dedicated site and deploy it via GitHub Pages. To improve readability and make it visually appealing, use a documentation framework such as Material for MkDocs, Docusaurus, Jekyll, GitBook, or another suitable tool.
Additional context
- The README.md should remain concise, highlighting key features, installation instructions, and links to the full documentation.
- The documentation site can include guides, API references, examples, and FAQs.
- A well-structured site will make it easier to scale documentation as the project grows.
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or requestgood first issueGood for newcomersGood for newcomershacktoberfesthelp wantedExtra attention is neededExtra attention is needed