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 updates with modules #1041

Merged
merged 11 commits into from
May 23, 2024
Merged

Conversation

adishgarg
Copy link
Contributor

@adishgarg adishgarg commented May 23, 2024

Description

  • all the modules mentioned in documentation.md added
  • search feature updated
  • file formatted accordingly

Resolves: [#1036 ]

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

Additional Notes/Comments

  • The modules that were added before hand from dev-documentation.md and were not present in documentation.md have not been removed from modules but have been commented out in mkdocs.yml hence will not appear in the documentation.

  • I have added a Guide page which contains the example usage and a link to the module in the documentation, like
    - [GitHub](modules/github.md). If necessary, I i will add the link to the respective repositories


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.

@adishgarg
Copy link
Contributor Author

the documentation for Github Education is missing in dev-documentation.md should i fix that as well?

@nikhil25803 nikhil25803 merged commit 669e1d8 into Clueless-Community:main May 23, 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 ✅

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