Start documenting design choices

[stefpiatek]

Actually documenting design choices. Hopefully a reasonable summary of what the options considered were, at least in the last year or so.

What else have I missed?

Reckon there'll be a lot so up for other suggestions of decisions that we've made that are worth noting

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.24%. Comparing base (9fe48f6) to head (cb0b186).
Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #574   +/-   ##
=======================================
  Coverage   87.24%   87.24%           
=======================================
  Files          76       76           
  Lines        3380     3380           
=======================================
  Hits         2949     2949           
  Misses        431      431           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[milanmlft]

Looking really nice 👌
Wonder if it's worth adding a record for the export API? From memory I seem to recall there was some back and forth on how to approach this as well, as we needed something flexible that can handle multiple destinations on a per-project basis.

[stefpiatek]

Looking really nice 👌 Wonder if it's worth adding a record for the export API? From memory I seem to recall there was some back and forth on how to approach this as well, as we needed something flexible that can handle multiple destinations on a per-project basis.

Oh yeah that's a fair point. Let me track down what we said about it

[tomaroberts]

@stefpiatek

I have had a read through this and it's clearly useful documentation and I found the context helpful. I can't contribute hugely as of yet, but please don't let me hold you up if you want to merge. Happy to revisit once I'm more familiar with the project.

Additional thought – these look a lot like Requirements to me; did PIXL start with a scoping and requirements phase?

[stefpiatek]

Additional thought – these look a lot like Requirements to me; did PIXL start with a scoping and requirements phase?

I think it did, but as a small part of a part of a much larger set of work. For its current purposes we picked it up from that tracer-bullet design