Documentation for the algorithms

[ming-tsai]

It'd be awesome to have a lot of documentation for the algorithm that was implemented in different languages

🐞 Problem
Currently, we have only a bunch of documentation of the algorithms
🎯 Goal
Have a lot of documentation of the algorithm

💡 Possible solutions
Add documentation of the algorithm

How to make it?
Check out Contribution Guidelines

📋 Steps to solve the problem

1. Comment below about what you've started working on.
2. Add, commit, push your changes
3. Submit a pull request and add this in comments - Addresses #
4. Ask for a review in the comments section of the pull request
5. Celebrate your contribution to this project 🎉

Please keep calm this is an open source project so wait until the reviewer has time to check it out the pull request.

[UG-SEP]

@ming-tsai please assign me I wanted to and binary search doc file

[Vedant488]

Is this a mistake by any chance? I think this issue should stay open because the documentation will require regular updates as new algorithms are added in the repository.

[ming-tsai]

Is this a mistake by any chance? I think this issue should stay open because the documentation will require regular updates as new algorithms are added in the repository.

Yes

[SubhamKumarPandey]

Greetings @ming-tsai !! I want to contribute for DSA. Please assign me any task so that I will continue working on it.

[viraj28]

Hi @ming-tsai, I am new to contributing stuff on open source. Is it okay to write documentation for the code that is already in the algorithms folder or should i write a new algorithm and then a document for it?

if okay, then can i write some documentation?

[ming-tsai]

Hi @ming-tsai, I am new to contributing stuff on open source. Is it okay to write documentation for the code that is already in the algorithms folder or should i write a new algorithm and then a document for it?

if okay, then can i write some documentation?

Yes @viraj28, I'm waiting your pull request

[ming-tsai]

Greetings @ming-tsai !! I want to contribute for DSA. Please assign me any task so that I will continue working on it.

Yes, you could check this repo if it is missing an algorithm then open an issue about it

[aakgn]

Pull Request: Singly Linked List Documentation #763

[codesmith25103]

Should I write Documentation about Vectors (C++)?

[ming-tsai]

Should I write Documentation about Vectors (C++)?

There is not obligation for documentation of the algorithms but inside of the algorithm file you should have the comments that reader to understand the process

[Ayebilla]

Hi @ming-tsai, may I write the documentation for the doubly linked list?
Thanks

[ming-tsai]

Hi @ming-tsai, may I write the documentation for the doubly linked list?
Thanks

Hi @Ayebilla,
Ok I will be waiting for the pull request.

[pyagnik1]

Hello @ming-tsai 👋, may I add documentation for balanced trees? Specifically, AVL trees and Red-Black trees. Thanks

[ming-tsai]

Hello @ming-tsai 👋, may I add documentation for balanced trees? Specifically, AVL trees and Red-Black trees. Thanks

Yes, I will be waiting for your pull request.

[pyagnik1]

Hello 👋 @ming-tsai I have added a new algorithm, Red Black Tree to the c file, here is the link to my pull request #845. I will add documentation for this algorithm in my next pull request. Please let me know if I can help in any other way. And thanks for giving me a chance.

[yashdodani]

May I add some examples on recursion in java?

[ahmedsilat44]

I found some typos in the documentation of MinHeap so I Fixed them

the PR is #851

[charu210703]

Can I add some code for stacks in python as well as the documentation?

[pranavyatnalkar]

Hello @ming-tsai 👋 may I add algorithms to insert and delete an element of a heap in C++? Thank you

[ming-tsai]

Hi @charu210703 and @pranavyatnalkar,
Yes, this is an open source project, everyone could make contributions to it, I will be waiting for your pull request 😊

[pranavyatnalkar]

Hello @ming-tsai 👋 I have added a new algorithm, here is the link to my pull request #866. I am also planning to add its documentation in my upcoming pull request. Thank you for letting me contribute!

[charu210703]

Hi @ming-tsai , I have added an algorithm for stacks, here is my pull request #880. Once it is merged, I will also add the documentation for the same. Thank you.

[tripathisharad]

Hello @ming-tsai can you assign me this this project I would like contribute on that.

[mohitkrsuman]

Hello @ming-tsai I have added a new popular algorithm sudoku solver in Backtracking.

[Denisthatorf]

Hi, I contribute for the first time, can I write Dijkstra algorithm documentation?

[ming-tsai]

Hi, I contribute for the first time, can I write Dijkstra algorithm documentation?

Yes, I will be waiting your pull request 😊

[aayush6200]

Hey !! I can contribute to DSA. I will actually present a question and solve it through the use of DSA. Assign me. Thanks

[ming-tsai]

Hi @aayush6200,
This is generic issue for the documentation of algorithms, you could open another issue to the algorithm that you want to document.

[RK-Shandilya]

I have generated a pull request of one new file Reverse the string wordwise #1100 . Can you review and approve it ?

[RK-Shandilya]

@ming-tsai I have generated a pull request of one new file Reverse the ll in groups of K #1106. Can you review and approve it ?

[iamRabia-N]

Hi! I want to write documentation on "Circular Linked List". Can you assign me this topic. I would like to contribute in it. Thanks.

[ShadyResurrected]

Can I write Bellman Ford algorithm documentation?