Feature/docs

[fralfaro]

What kind of change does this PR introduce?

• [ ] Add a project
• [ ] Update a project
• [ ] Remove a project
• [ ] Add or update a category
• [ ] Change configuration
• [x] Documentation
• [ ] Other, please describe:

Description: Migration of the code in https://fralfaro.github.io/catalog/ (but in PR is with mkdocs user). The documentation was mostly done with mkdocs (+ mkdocs plugins)

I'm thrilled to have completed the documentation for this important library. It's been an exciting project, and I'm grateful for the opportunity to contribute.

• [x] I have read the CONTRIBUTING guidelines.
• [x] I have not modified the README.md file. Projects are only supposed to be added or updated within the projects.yaml file since the README.md file is automatically generated.

🔑Note: If you found this documentation helpful, it would be great if you could follow me on GitHub for more updates and future collaborations!

[pawamoy]

Hello @fralfaro, thank you very much for contributing to this project!

While the result looks good, I'm very sorry to say that this is not mergeable in the current state. I hope you would have created an issue or discussion first, before doing all this work.

You see, the contents of the README are generated automatically using the data in the projects.yaml file. It's updated weekly, giving us an up-to-date ranking. Without automatic generation, this would be impossible to stay up to date or even maintain the README.

Your changes however seem to provide the final contents once and for all. I don't see any script generating the documentation files. Maybe you used one but didn't include it in this PR? If so, please show us this script before we continue the discussion. If not, I'm afraid these changes are not maintainable and I'll most probably close the PR :confused:

[fralfaro]

Hello, I understand. I will create a new 'issue'. Also, I will be looking for a way to automate the documentation with the projects.yaml file.

Thank you very much for the suggestions. I hope to have contributed a little with the documentation.

[pawamoy]

Thank you for your understanding. Closing then :slightly_smiling_face: