You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
the current documentation for mkdocs doesn't cover all the aspects like usage and the files need to be formatted
ensure all the modules are covered which are mentioned in documentation.md and only which is mentioned in documentation.md.
Add search feature (if possible) as there are a lot of them
Format all the markdown files in docs folder properly because you can see in the right that it generates table of contents on the basis of headings in the markdown files.
Record
I agree to follow this project's Code of Conduct
I'm a GSSoC'24 contributor
I want to work on this issue
The text was updated successfully, but these errors were encountered:
Hi there! Thanks for opening this issue. We appreciate your contribution to this open-source project. We aim to respond or assign your issue as soon as possible.
What's wrong with the existing documentation
the current documentation for mkdocs doesn't cover all the aspects like usage and the files need to be formatted
ensure all the modules are covered which are mentioned in documentation.md and only which is mentioned in documentation.md.
Add search feature (if possible) as there are a lot of them
Format all the markdown files in docs folder properly because you can see in the right that it generates table of contents on the basis of headings in the markdown files.
Record
The text was updated successfully, but these errors were encountered: