Update README.md

README.md

@@ -1,6 +1,6 @@
 # static-web-templates
 
-A template-based solution for inflating different types of content without the need for a server or database.
+This repo holds the various projects associated with `@goldenwere/static-web-templates`, a template-based solution for inflating different types of content without the need for a server or database.
 
 ## Local Development
 
@@ -26,10 +26,6 @@ You can run `npm start -w=frontend` in the terminal to spin up a server. Open th
 
 TBA
 
-## Architecture
-
-TBA
-
 ## Background
 
 > As an artist, I wanted a way to share my art online without restrictions regarding content or niche. I also wanted a way to show a list of my games all in one spot for my developer alias. On top of that, I needed a way to showcase a portfolio of all my development projects for work/job searching. And finally, I wanted a landing website that simply linked to all other profiles I have and provide a sort of bio. These are several different websites, but all were similar in function: they were websites which all statically displayed dynamic content (static meaning that there is no server-side processing or reaction to user input). With the individual sites needs, the idea of creating templates for these goals came to be. To determine how the sites should be set up, I broke down the needs these sites shared:
@@ -45,3 +41,26 @@ TBA
 > In less technical terms: the site feels like a modern website but works more classically and without any need for a server, database, or other costly solution for hosting. This means you can just build the files and dump them on a free/cheap static host, and you can update content (add new images to a gallery, fix a type on a single About Me page, etc.) without rebuilding the whole site.
 >
 > This is a very niche project which probably won't be useful to many, but for those who want the benefits of modern web frameworks without the downsides, for those who want the main site to just be built once in a blue moon and can just change some content whenever they need to, and for those who don't want to pay a lot or be limited by third party hosts/builders/services for a simple website, this project is made for that.
+
+## Architecture
+
+This repo is set up to be a monorepo to help manage different projects under the `static-web-templates` umbrella. The repo is divided into the following:
+- libs: libraries which are package-like and meant to be consumed in a project
+  - types: shared types between the remaining libs/projects
+- projects: end-products which are app-like meant to be built and deployed
+  - frontend: the actual static website generator
+  - sites: a placeholder for testing and/or managing multiple websites with the same static website generator
+
+### /projects/frontend
+
+TBA
+
+### /projects/sites
+
+This package helps manage multiple websites in one place. The `./sites` folder is hidden by default for the sake of the main `static-web-templates` repo and is meant for maintaining dynamic content outside of source control. It is recommended to sync these sites directly with `/content` on whatever webhost is being used to host the site, such that:
+  1. deployment of the `/projects/frontend` project should ignore these sites' `/content` by excluding `/content` from the final build and ensuring the deployment API can leave `/content` unmodified remotely
+  2. syncing of the sites should ignore all other files besides `/content` by syncing directly with the `/content` folder
+
+Note that some hosts, such as [surge.sh](https://surge.sh), do not allow for management of individual files and instead require that all files be pushed in one go. In that case, make sure the `/content` folder is present when the `/projects/frontend` project is built before syncing, and sync content changes with the `/projects/frontend` build instead.
+
+TBA: ensure build command has option to include or exclude `/content` when building or provide separate build commands