← Back to context

Comment by albertzeyer

16 days ago

It's not just a problem when you are an amateur. This is sth that every project should provide.

But there are also many projects which do. Sometimes you need to search a bit for it. Actually I would expect that most big projects have such documentation somewhere in some form.

- WebKit: https://github.com/WebKit/WebKit/blob/main/Introduction.md

- Chrome/Chromium: https://www.chromium.org/developers/how-tos/getting-around-t...

- PyTorch: https://github.com/pytorch/pytorch/blob/main/CONTRIBUTING.md...

- RETURNN (my own): https://returnn.readthedocs.io/en/latest/getting_started/tec...

- Mold: https://github.com/rui314/mold/blob/main/docs/design.md

And then for some popular projects you will also find some independent overviews:

- Quake: https://fabiensanglard.net/quake3/ (and many more on https://fabiensanglard.net/)

- Linux: https://tldp.org/LDP/khg/HyperNews/get/tour/tour.html

- CPython: https://realpython.com/cpython-source-code-guide/

- LLVM: https://blog.regehr.org/archives/1453

One problem is of course that those documents can be outdated and don't go into much details. But they still will give you important insights and should be a good starting point.