Internal Documentation

[Oipo]

I'd like to help with adding features to hiberlite, but documentation on how hiberlite works is a bit sparse. Do you mind adding this? Is there a way I can help otherwise?

[paulftw]

Yes, we should write more of it. Main question is where to start.

Problems I see for beginners are:

• knowing where code that does X is;
• what classes are responsible for what.

@d-led what were the challenges when you started working on pull requests? Is there anything that is still a mistery for you?

Often requested feature is search/query support. Other approach could be documenting the steps to implement it and reasons behind the choices. Queries touch a lot of aspects, so picking a smaller feature would be better, even if not as useful.

[d-led]

@paulftw, I think, an architectural overview is always good to increase acceptance for developers, however, digging in the code and finding out how it works can be fun too. I would like, i.e. add a configuration feature, but have postponed it until a later time, where I'll find time to extract a general style in which you have created the library, so that my pull requests wouldn't disturb the general picture of the library unnecessarily.

Practically, we can start with a wiki (perhaps in Markdown) here, on which we all could work in parallel, adding bits of information, such as the general picture, what the macros really do, how the encapsulation of the backend looks, etc.

Let's create a file and fill bullet points first as we find time for the task. @Oipo could contribute too, pointing out information he'd like to see in such an overview.