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:
guiding principles (with explanatory examples)
naming and organisation of packages in org
suggested default software architecture for brainglobe tools
This PR further
incorporates the high-level intro into the wider website
adds some knowledge that was living in our heads to website text, this includes:
handling of user data (GIN, pooch, .brainglobe folder)
documentation around test data
axis ordering docs
a link to the core development project board
release process across repos (particularly interested in @willGraham01 looking at this part!)
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.
Asking for feedback from any active developers who have time to look but in particular
@viktorpm because it would be beneficial to get review from someone less familiar with the wider codebase, and because you asked me about this last week 😉
@willGraham01 because you have done the lion's share of recent releases and restructures
@adamltyson because you have the best bird's eye view of the entirety of brainglobe
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
.brainglobe
folder)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: