Add high level overview of cell detection stages

[dstansby]

Fixes https://github.com/brainglobe/cellfinder-core/issues/129. Please be harsh when reviewing - anything that needs clarifying or adding should happen in this PR.

[adamltyson]

Thanks for writing this up @dstansby. My only concerns about these docs are whether anyone would know to look into this file and whether we would keep them updated. Any thoughts @alessandrofelder?

[dstansby]

Definitely agree this isn't ideal, but until the documentation lives in repositories I think this is the best option?

[alessandrofelder]

Agree with David... we could open an issue that reminds us to move this to somewhere we keep high-level technical docs in the future (once we move to the new documentation system)?

One approach that I've used before to remember to keep the high-level technical docs ("developer docs"?) up-to-date is to add a tickbox to the PR template that looks something like:

• [ ] Developer docs have been updated (or no update required)

which the reviewer is supposed to think about and tick if satisfied?

[adamltyson]

Definitely agree this isn't ideal, but until the documentation lives in repositories I think this is the best option?

Agree

One approach that I've used before to remember to keep the high-level technical docs ("developer docs"?) up-to-date is to add a tickbox to the PR template that looks something like:

Developer docs have been updated (or no update required)

which the reviewer is supposed to think about and tick if satisfied?

Good idea. It should prompt us if nothing else.

[alessandrofelder]

opened https://github.com/brainglobe/cellfinder-core/issues/157 to remind us to move docs to https://github.com/brainglobe/new-website one day.