brainglobe / brainglobe.github.io

brainglobe.info website
https://brainglobe.info/
Creative Commons Attribution 4.0 International
10 stars 8 forks source link

Expand the developer documentation #144

Closed alessandrofelder closed 9 months ago

alessandrofelder commented 9 months ago

Description

What is this PR

Why is this PR needed?

As a novice (and even as an experienced contributors), it's currently not easy to get a quick, good overview of the how the BrainGlobe code base is organised.

What does this PR do?

This PR represent a major fleshing out of the developer docs.

This PR adds a high-level introduction to the code base for new and existing contributors. It includes:

This PR further

Note that some of the information about the tool names is slightly ahead of our renaming/merging tool repos schedule 😬 It considers https://github.com/brainglobe/BrainGlobe/issues/43 as already addressed.

References

Closes https://github.com/brainglobe/BrainGlobe/issues/47 Closes https://github.com/brainglobe/brainglobe.github.io/issues/8 Closes #81

https://github.com/brainglobe/BrainGlobe/issues/16 to be tackled separately to this.

How has this PR been tested?

Inspection of local build of website.

Is this a breaking change?

No

Does this PR require an update to the documentation?

This PR is an update to the documentation

Checklist:

alessandrofelder commented 9 months ago

Asking for feedback from any active developers who have time to look but in particular