Wouldn’t need to be crazy detailed but at least start with a rough overview of how things work now, and go bit more into detail where needed just so we have it documented how we expect things to work. This might be interesting when debugging things or when someone is not clear or so.
Of course it be a bit like where do we start and where do we end… archive invalidation and archive deletions is already a big topic by itself… eg we could list when are archives deleted like
An archive is being invalidated when
A newer archive for same day has been invalidated
That would be valuable. Also important for future new team members to get their head around it :+1:
Here is a proposal for the new sections:
browser archiving vs pre-archiving: basics of both approaches, some of this info is already there. for all following sections we talk about the topic for how it applies to both browser archiving and pre-archiving.
archive initiation: how is archiving started? answer for browser archiving & for pre-archiving
archive invalidation: how are existing archives invalidated, what makes an archive invalidated, how is this done in code and handled by browser vs pre-archiving
archive purging: how are old archives deleted? at what other times are archives deleted?
partial archives: what are they, how do they fit into initiation/invalidation/purging workflow, how do archivers handle this, how do plugins initiate it, + a note that it doesn't work for browser archiving
does this work?
There are a couple changes to be made in the closed developer-documentation PR, will finish them soon.