search

feincms / django-tree-queries

Adjacency-list trees for Django using recursive common table expressions. Supports PostgreSQL, sqlite, MySQL and MariaDB.
https://django-tree-queries.readthedocs.io/
BSD 3-Clause "New" or "Revised" License
433 stars 27 forks source link

Greate idea but proper documentation is needed #7

Closed AlekseiKhatkevich closed 2 years ago

AlekseiKhatkevich commented 4 years ago

I dont understand how to use it. Please add some docs with examples

matthiask commented 4 years ago

Thanks for the report. You're right, the documentation is bad right now. In the meantime, I hope the following links help get you up to speed:

Here are a few examples: https://feincms3.readthedocs.io/en/latest/guides/navigation.html

The testsuite has a few examples too https://github.com/matthiask/django-tree-queries/blob/master/tests/testapp/test_queries.py

matthiask commented 2 years ago

I think I'll count this as fixed now that the README has a Recipes section.

https://github.com/matthiask/django-tree-queries#recipes