Documentation about algorithms

[ming-tsai]

Hi guys,
Now a day we have all algorithms, but we don't have the documentation about each one of them, I think to make some changes to the folder.

• Move all algorithms to the algorithms folder
• Create a docs folder, it will contain the docs of the algorithms

What are you thinking?

[github-actions]

It's great having you contribute to this project

Thank you for raising an Issue, Welcome to DSA

We will review everything and get back to you, Please checkout our CONTRIBUTING RULES and CODE OF CONDUCT, Thanks 😃

[TawfikYasser]

Yes @ming-tsai It is a good idea, Really, I feel that the repository is now disorganized and needs to be indexed to be easier for learners and also for new contributors.

[TawfikYasser]

Daily I'm thinking about how to make the repo. more attractive and to not only contain DSA

We want to expand the fields in order to provide the opportunity for a larger number of people to contribute, for example adding other types of contributions, not only algorithms and data structures (DSA), for example, another part for beginners in programming and CS in general to add the small programs that they work on on the one hand they learn how to deal with GitHub and from On the other hand, in preserving their works, and so with other types, what do you think @ming-tsai , and we can also see suggestions.

[ming-tsai]

Good point

[cclauss]

In building https://github.com/TheAlgorithms we took a one-repository-per-language approach and separate Algorithms Explanation repo. repo-per-language allows contributors and maintainers to focus on the languages that they know (or want to learn). Communities build separately but there is a lot of compare and contrast that maintainers do to move best practices from one language community to another. Automated testing usually varies quite a bit from language to language so the community can also collaborate to demonstrate best practices for automated testing and lining for their focused language. Moving the algorithm explanations to a separate repo allows doc-centric contributors to build the docs in multiple human languages. It ensures that the docs are not built too close to only one implementation. Another trick that is worth looking at is that most repos automatically build a DIRECTORY.md file as new algorithms are added. Without automation, this becomes an increasingly error-prone tedious task.

[apex-blaze]

Yes, I actually agree with @cclauss , because the file structure we currently have is kinda mess. We have folders denoting the data structures, within them we have sub-classified our languages. Due to this, alot of algorithms have been coded in just 1 or 2 languages and rest are missing. It's better to have languages separated from root folder or the one @cclauss has mentioned.

[ming-tsai]

Actually, I would like to make some different way of TheAlgorithms, I'm thinking we could be as below folder structure:

algorithms
  |--c-or-c++
     |-- search
         |-- binary-search.cpp
     |-- README
  |--java
     |-- search
        |-- binary-search.java
     |-- README
  |--csharp
     |-- search
         |-- binary-search.cs
     |-- README
  |--python
     |-- search
         |-- binary-search.py
     |-- README
docs
  |-- search
     |-- binary-search.md

For each algorithm, the folder contains the source and tests, then we could create the Github action to check each language, and create an action that could update the index readme automatically like this one

[ming-tsai]

This is my opinion, and we won't need to change all files, only need to move folder, create the actions and create automatically job

[cclauss]

That works.

My sense is that languages are brand names (I bet language communities agree) so C, C++, JavaScript, Python are more respectful than all lowercase. python is a snake and Python is a programming language.

[ming-tsai]

Ok, we could change that rule

[ming-tsai]

I will starting moving CSharp and Javascript folder

[ming-tsai]

Done with C#