This idea is still very raw in my mind, so apologies in advance for
being deliberately vague. For the last few weeks I have been thinking
on ways to address the sorry state of our internal documentation.
We all agree that none of us has global knowledge of all aspects of
the compiler. It's just impossible. So, we have the collective
knowledge distributed all over the place but it is pretty hard for
someone to navigate the compiler without talking to N different
people.
So, I think the problem goes a bit beyond mere documentation of how a
module works at a high level. I would like to have a navigable
document that also describes the flow of things, interfaces and
helpers. Starting at main.c:main() and ending at toplev.c:finalize().