Adding developer documentation

[PrasadBabarendaGamage]

This outline is outdated, see the latest outline on issue #65

This documentation has been built along with the OpenCMISS website and it builds fine with no errors. There are warnings regarding figure numbering, however, these will be addressed in another documentation issue as they are not critical.

0. Key/simplified steps
   • making your own topic branch
1. (completed) Guidelines for contributing to OpenCMISS
2. (completed) Development Setup
3. (placeholder) Building OpenCMISS for developers
   • The procedure for using the manage repo to build OpenCMISS from source (described in the Further Details section of the existing Building OpenCMISS Libraries From Source needs to be moved here.
   • The simpler procedure for getting started using the setup repo (i.e. for users) can be moved to a getting started section.
4. (placeholder) Coding Standard
   • Need to add separate sections for,
   • Fortran [Here is the link to coding style in Iron's doxygen documentation] (https://github.com/OpenCMISS/cm/pull/172/files).
   • C, C++, python (link to Google style guide for these)
5. (placeholder) Documenting your code
   • How to add documentation to code simple doxygen comments
   • How to add sphinx documentation
   • Among other things, we need to move or link the information in the 'Guide to contributing documentation' contained in the CONTRIBUTE.md of the OpenCMISS/documentation repo here.
6. (placeholder) Testing code
   • testing yourself
   • testing your fork using Jenkins (optional). Need to add documentation on how to use Jenkins.
   • mention that the code will be automatically tested each time a commit is added to a pull request
7. (completed) Contributing
8. (completed) Review Process
9. (placeholder) API Documentation
   • This section can be renamed 'technical documentation'. Need to add links to API docs that are currently in the Technical documentation section of the OpenCMISS website.

Addresses issue #65

[PrasadBabarendaGamage]

Hi guys, Andre has reviewed/approved this pull request, hoping if we could pull it in into the develop branch. This will automatically trigger an update to the staging.opencmiss.org website.

[PrasadBabarendaGamage]

Can add the TL;DR section in again in another pull request (but we probably need to define the term as some noobs like myself have no idea what that means and it becomes confusing).

[PrasadBabarendaGamage]

Actually might be better to add the TL;DR section to another page called Quick start. So that it does not confuse newbie developers.

[hsorby]

I really don't think we need to define the term, if people can't figure it out (and google is pretty useful for this sort of stuff) then they are going to have trouble using Iron and Zinc.

[chrispbradley]

We shouldn't have terms like TL;DR in the web documentation or indeed any other internet lingo, amusing or not. There is a significant academic side to the project and many people from grant reviewers and collaborators look at the site. The site should be able to pass the 60 yo professor reading it test. I'm afraid TL;DR does not really pass this test.

[rchristie]

I'm also against TL;DR and prefer 'Quick Start' or similar.