digitalfabrik / integreat-cms

Simplified content management back end for the Integreat App - a multilingual information platform for newcomers
https://digitalfabrik.github.io/integreat-cms/
Apache License 2.0
55 stars 33 forks source link

Document MPTT models (`AbstractTreeNode`) #1917

Open PeterNerlich opened 1 year ago

PeterNerlich commented 1 year ago

Motivation

While working on #1772, it took considerable time trying to understand LanguageTreeNodes and how they tie into the system. The documentation of treebeard does also not help with understanding properties like lft or rgt, while the link to the referenced idea which they implemented is dead.

Proposed Solution

Alternatives

Don't improve documentation and risk having to spend a lot of time researching how the Language Tree and NS_Nodes work next time

Additional Context

Lacking documentation in treebeard (excerpt). The second link in the first paragraph is dead. image

PeterNerlich commented 1 year ago

Timo dropped a bit of knowledge in https://github.com/digitalfabrik/integreat-cms/pull/1930#discussion_r1042632899