msiemens / tinydb

TinyDB is a lightweight document oriented database optimized for your happiness :)
https://tinydb.readthedocs.org
MIT License
6.84k stars 550 forks source link

Improving documentation to publicize and share the project and codes #580

Open mateustoin opened 1 week ago

mateustoin commented 1 week ago

Hi everyone,

I've been thinking about contributing a little to the project's documentation, mainly based on what I saw in the discussion in #371. Based on what I think of the project, there are still many ways to make it more widely used and useful for people, especially those who are just starting out in programming or doing small personal projects.

That said, my suggestion is to add How-To and Tutorials sections so that people can more easily visualize some basic applications and get inspired. I'm leaving the necessary structure for this, and then I can add at least one example of each on the page.

In addition, I also created the examples folder to make it easier to access the code and run it without any major problems, so it's also easier to share and send to other people to test it more directly.