Documentation Issues Guidelines
geekquad opened this issue · 0 comments
geekquad commented
The guidelines for documentation issues go here
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's simple, digestible to a beginner. When someone in the future comes looking for your documentation, they understand it and would thank you for the effort you put in.