New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Restructure and extend documentation #371
Comments
probably writing extensions, with a little description of the internals (how to extend the code?). |
It's been awhile since I worked with TinyDB and I was looking up how to use db.upsert.
This is confusing because I would be happy to help with documentation or short how to guides or examples. Point me in a direction and I can help some. |
That's a good point. Basically the current documentation assumes that it is read from top to bottom. Instead we should split it into more subpages that have self-contained examples.
That's great! 🙂 I think we should have an examples section that contains commonly used operations. If you like you could contribute your experience from working with TinyDB about what examples would be most helpful. I'm still not sure how to organize this best. Maybe I'll start a pull request where we could have discussions about these matters. Or maybe start collecting examples in the GitHub project wiki. What do you think? |
Note to self: document using |
This is a note to myself to rework, restructure and extend the documentation based on the principles layed out in https://documentation.divio.com/introduction/ (and https://v3.vuejs.org/guide/contributing/writing-guide.html for that matter).
I considering adding a how-to section in the process. If anyone has ideas about what topics would be useful for short how-to guides/articles, feel free to comment on this issue 🙃
The text was updated successfully, but these errors were encountered: