DSA icon indicating copy to clipboard operation
DSA copied to clipboard

Documentation for the algorithms

Open ming-tsai opened this issue 3 years ago • 33 comments

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 🎉

ming-tsai avatar May 07 '21 23:05 ming-tsai

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

UG-SEP avatar Jun 14 '21 14:06 UG-SEP

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.

Vedant488 avatar Jun 24 '21 18:06 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.

Yes

ming-tsai avatar Jun 25 '21 13:06 ming-tsai

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

SubhamKumarPandey avatar Aug 28 '21 13:08 SubhamKumarPandey

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?

viraj28 avatar Aug 29 '21 09:08 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?

Yes @viraj28, I'm waiting your pull request

ming-tsai avatar Aug 29 '21 16:08 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

ming-tsai avatar Aug 29 '21 16:08 ming-tsai

Hi @ming-tsai can I start working on Heap sort documentation? Thanks :)

Gigolino2001 avatar Sep 17 '21 17:09 Gigolino2001

Hi @ming-tsai can I start working on Heap sort documentation? Thanks :)

Yes, I will waiting your pull request

ming-tsai avatar Sep 17 '21 19:09 ming-tsai

Hi @ming-tsai, can I add documentation for min heap?

ryzheboka avatar Oct 05 '21 08:10 ryzheboka

The implementation of ternary search in C seems to search for a value (that is passed as parameter) in an array. But the Wikipedia page about ternary search defines it as an algorithm that searches for a minimum or maximum of a function. I would like to write documentation for ternary search, but I am a little bit lost there.

ryzheboka avatar Oct 05 '21 08:10 ryzheboka

The implementation of ternary search in C seems to search for a value (that is passed as parameter) in an array. But the Wikipedia page about ternary search defines it as an algorithm that searches for a minimum or maximum of a function. I would like to write documentation for ternary search, but I am a little bit lost there.

Hi @UG-SEP, Could you explain his about the algorithm?

ming-tsai avatar Oct 05 '21 12:10 ming-tsai

Could I add documentation for min heap in the meantime?

ryzheboka avatar Oct 06 '21 08:10 ryzheboka

Could I add documentation for min heap in the meantime?

Yes, I will wait for your pull request

ming-tsai avatar Oct 06 '21 13:10 ming-tsai

Thanks :)

ryzheboka avatar Oct 06 '21 15:10 ryzheboka

hey can you assign me this pull request . i also want to add documentation of Backtracking Algorithm.

sunil14701 avatar Oct 13 '21 10:10 sunil14701

hey can you assign me this pull request . i also want to add documentation of Backtracking Algorithm.

Hi @sunil14701, This issue is generally, so it isn't going to assign to anyone, but you could open a new issue documentation of Backtracking Algorithm.

ming-tsai avatar Oct 13 '21 11:10 ming-tsai

Hi @ming-tsai , Do you want documentation in markdown or code comments?

banerjeesoumya15 avatar Feb 12 '22 16:02 banerjeesoumya15

Hi @ming-tsai , Do you want documentation in markdown or code comments?

Hi @banerjeesoumya15, This issue is for markdown documentation.

ming-tsai avatar Feb 12 '22 16:02 ming-tsai

Hi @ming-tsai , I am new to contributing stuff on open source. I would like to translate DSA/tree/main/docs/en/Bubble-Sort.md into Japanese and add to DSA/tree/main/docs/ja. Is it OK?

k2491p avatar Feb 26 '22 15:02 k2491p

Hi @ming-tsai , I am new to contributing stuff on open source. I would like to translate DSA/tree/main/docs/en/Bubble-Sort.md into Japanese and add to DSA/tree/main/docs/ja. Is it OK?

Ok, I will wait for your pull request.

ming-tsai avatar Feb 26 '22 15:02 ming-tsai

Hey @ming-tsai I am working on the en documentation for count sort. Is that ok?

Konnor-Young avatar Mar 21 '22 19:03 Konnor-Young

Hey @ming-tsai I am working on the en documentation for count sort. Is that ok?

Yes @Konnor-Young, I'm waiting for your pull request.

ming-tsai avatar Mar 21 '22 19:03 ming-tsai

Hi, could I add documentation for the singly linked list algorithm?

aakgn avatar May 26 '22 19:05 aakgn

Hi, could I add documentation for the singly linked list algorithm?

Hi @aakgn, Yes, I will wait for your pull request 🤗🤗

ming-tsai avatar May 26 '22 20:05 ming-tsai

Pull Request: Singly Linked List Documentation #763

aakgn avatar Jun 04 '22 15:06 aakgn

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

codesmith25103 avatar Aug 01 '22 03:08 codesmith25103

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

ming-tsai avatar Aug 02 '22 19:08 ming-tsai

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

Ayebilla avatar Aug 19 '22 08:08 Ayebilla

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.

ming-tsai avatar Aug 20 '22 15:08 ming-tsai