Contribution Docs

[rule-of-3]

Here we aim to create a new part of the CPR docs, aimed at (prospective) contributors. This is not intended to be an exhaustive reference of the library functions, classes and templates, but an overview and explanation of the project's structure and design philosophy.

[COM8]

Looks really promising. Thanks!

Here are a few comments from my side.

[rule-of-3]

Thank you very much for going through the text so thoroughly and giving this feedback! It's obvious that I'm still getting the hang of writing docs, but it shouldn't take long!

There's some more ideas that I think may be useful and intend to include, and I'm also trying to get ideas to make it a bit less wall-of-text looking.
This was the intention behind including the links to the master branch headers, so that the reader can be jumping to see some code while they're reading it. It would be quite nice to have links to specific function declarations/ signatures, too, but as far as I know github only allows links to specific lines of code, and they'd fast become irrelevant with commits getting merged to master. This could, of course, be avoided by linking to a specific branch that isn't going to get many changes, such as 1.10.x, but that would generate a bit of overhead to keep it up to date every time the library jumps up a version. So I thought targeting master is a good compromise.

All things considered, I think there's a bit of work to be done till this PR can be considered for merging. Thanks again!

[COM8]

Agree. Pointing to specific functions would be awesome, but would require more maintenance. At some point we have to introduce/switch to some partially automated documentation system like doxygen or read the docs. But until then linking to master is totally fine.

[rule-of-3]

Sadly, life got in the way and I wasn't able to complete this PR. I won't delete the branch, however, and if anyone wants to use these files or continue it they are free to do so.