With expansion into having a Staging version of the site via galago-labs "Staging" repo and the primary galago repo now representing the Prod state of the app, the README should be updated to explain this process. Also should explain some of the interaction with GitHub Actions, how merging to main in a repo kicks off a deploy for that site, etc.
Note that we generally want the Staging galago-labs and the Prod galago repos to have identical code (at least whenever we make a merge from galago-labs into galago, before whatever next bit of dev work happens), so make sure to approach writing the README as not knowing which repo it's being viewed from. The README must be written in a way where identical content manages to explain both repos, don't do anything from the POV of the repo the user is currently reading, because the README doesn't have that context, it's just the same doc displayed in two places.
With expansion into having a Staging version of the site via
galago-labs
"Staging" repo and the primarygalago
repo now representing the Prod state of the app, the README should be updated to explain this process. Also should explain some of the interaction with GitHub Actions, how merging tomain
in a repo kicks off a deploy for that site, etc.Note that we generally want the Staging
galago-labs
and the Prodgalago
repos to have identical code (at least whenever we make a merge fromgalago-labs
intogalago
, before whatever next bit of dev work happens), so make sure to approach writing the README as not knowing which repo it's being viewed from. The README must be written in a way where identical content manages to explain both repos, don't do anything from the POV of the repo the user is currently reading, because the README doesn't have that context, it's just the same doc displayed in two places.