Documentation on Kakoune's design

Currently when I’m looking into an issue, I have to spend a lot of time to figure out what path through the code is taken to end up at the point in the code that I’m looking at.

It would be nice if there was some document that explained how all the different classes in Kakoune’s source code work together, for example, how works together with and how that relates to the different ui files, etc.

Is anyone else missing this kind of documentation?

This documentation could also be included in the code in the form of extensive explanations for functions/classes that tell how they are used, what their function is, etc.

1 Like

Back in the day, I started this page providing a summary of some of the files:

It definitely would help if it was less succinct and depicts how each files/concept interact with each others.

1 Like