Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Mkdocs Updation #1036

Closed
3 tasks done
adishgarg opened this issue May 21, 2024 · 3 comments
Closed
3 tasks done

Mkdocs Updation #1036

adishgarg opened this issue May 21, 2024 · 3 comments
Assignees
Labels
gssoc GSSoC 2024

Comments

@adishgarg
Copy link
Contributor

adishgarg commented May 21, 2024

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

  • I agree to follow this project's Code of Conduct
  • I'm a GSSoC'24 contributor
  • I want to work on this issue
Copy link

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.

@adishgarg
Copy link
Contributor Author

please asign this issue to me @nikhil25803

@nikhil25803
Copy link
Member

Go ahead @adishgarg

@nikhil25803 nikhil25803 added the gssoc GSSoC 2024 label May 22, 2024
@adishgarg adishgarg changed the title DOC: Mkdocs Updation May 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
gssoc GSSoC 2024
Projects
None yet
Development

No branches or pull requests

2 participants