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

Documentation Issues Guidelines #80

Closed
ashwani-rathee opened this issue Mar 14, 2021 · 0 comments
Closed

Documentation Issues Guidelines #80

ashwani-rathee opened this issue Mar 14, 2021 · 0 comments

Comments

@ashwani-rathee
Copy link
Collaborator

ashwani-rathee commented Mar 14, 2021

The guidelines for documentation issues go here
Several good examples from your fellow participants : #83 #84 #78
What you need for documentation:

Heading of the algorithm

Introduction : definition,history
How Algorithms Works? : algorithms steps,ideas behind the algorithm
Advantages
Disadvantages
Applications :where it's used
References : link for further reading,links to youtube vids so
Write it in a way that it's simple,digestible to a beginner.When someone in future who comes looking for your documentation,they understand it and would thank you for the effort you put in.

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

No branches or pull requests

1 participant