Skip to content

Documentation Issues Guidelines #80

Description

@ashwanirathee

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions