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 updated with uses and installation #1032

Merged
merged 12 commits into from
May 21, 2024

Conversation

adishgarg
Copy link
Contributor

@adishgarg adishgarg commented May 21, 2024

Description

created the navbar in mkdocs and updated it with installation, contribution and usage guide covering almost half of the uses described in dev-documentation

Resolves: [#1005]

Checklist

Before submitting this pull request, kindly verify that the ensuing checkpoints have been reached.

  • Have you adhered to the repository's defined coding convention rules?
  • Have you updated the 'documentation.md' file with the method/function documentation?
  • Have you sent a message along with the result or response?
  • Have you used the try-catch technique?
  • Has the method/class been added to the documentation (md file)?

Screenshots

Uploading a screenshot illustrating the approach you developed for validation is required.
image

If the following PR is approved i would like to add the rest of documentation as well

Any additional remarks or suggestions concerning this pull request are welcome.


I certify that I have carried out the relevant checks and provided the requisite screenshot for validation by submitting this pull request.
I appreciate your contribution.

@nikhil25803 nikhil25803 merged commit 24893cb into Clueless-Community:main May 21, 2024
@nikhil25803
Copy link
Member

Great work @adishgarg !!
Do not forget to

  • Share your contribution on socials and tag Clueless 🫂
  • Give this repository a star ✨
  • Follow Clueless Community on GitHub ✅

@nikhil25803
Copy link
Member

Hey @adishgarg, I would like you to continue work on this feature.

What we need is

  • 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.

Do raise an issue for it, an I'll assign you the issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
gssoc GSSoC 2024 level3
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants