Update README and CONTRIBUTING

Author: myShoggoth

CONTRIBUTING.md

@@ -30,20 +30,14 @@ unjustifiable changes to the existing code.
 
 ### Building the site
 
-Refer to the [README](README.md) for more information on building the site. Since `haskell.foundation` is a Hakyll-based site,
-it has a `watch` feature which allows for fast iteration. However, due to the limitations of the Github pages framework,
-the site is watched through the `docs` directory. In order to build the site *and* have those changes propagated, you *must run
-the `./build.sh` at the root of this project!*
-
-To run the `build.sh`, simply issue the following when you are done making changes:
-
-```bash
-./build.sh
-```
-
-Please remember to include this with your merge requests.
+Refer to the [README](README.md) for more information on building the site.
 
 ## Code Quality
 
 The `haskell.foundation` project intends to focus on integration and usability,
 balanced with maintainability.
+
+We strive to be an example of best practices for real Haskell. If you believe
+there is a better way to do something in the code, please let us know or
+submit a PR for review. We would like the HF website to be a clear example of
+how to do a Hakyll website right.

README.md

@@ -10,50 +10,45 @@ This repository is for the [haskell.foundation](https://haskell.foundation) webs
 
 ## Table Of Contents
 
-- [Building](#building)
-  - [Nix](#nix)
-  - [Cabal/Stack](#cabal/stack)
-- [License](#license)
+- [The Haskell Foundation Website](#the-haskell-foundation-website)
+  - [Table Of Contents](#table-of-contents)
+  - [Building](#building)
+  - [CI](#ci)
+  - [License](#license)
 
 
 ## Building
 
-
-### Nix
-
 To build the project:
 
 ```bash
-nix-build
+stack build
 ```
 
-To run the local development server:
+Once the project has built (which can take a while due to the dependencies for Hakyll), to generate the site use:
 
 ```bash
-./watch.sh
+stack exec -- site build
 ```
 
-Alternatively, you can drop into a nix-shell with
+The site will be build in the `_site` directory, and you can open the files in your browser of choice. Due to a Hakyll issue, some sponsor logos will not show up correctly. This is expected behavior, and should be fine for the deployed site.
 
-```bash
-nix-shell
-```
+For further information, please refer to the [CONTRIBUTING.md](CONTRIBUTING.md) at the root of this project.
 
-And call the website watch command directly via Cabal or Stack:
+## CI
 
-```bash
-cabal run haskell-foundation -- watch
-```
-
-### Cabal/Stack
+We use GitHub Actions `.github/workflows/main.yml` to build the site for production.
 
-The site can be built locally with Cabal and Stack if the 3rd party dependencies are met, and by issuing the following in terminal:
-
-```base
-cabal run haskell-foundation -- watch
-```
+The general steps are:
 
-Or the stack equivalent. For further information, please refer to the [CONTRIBUTING.md](CONTRIBUTING.md) at the root of this project.
+1. Check out the `hakyll` branch
+2. Install Haskell
+3. Restore the cached build artefacts
+4. Build the `site` executable
+5. Rebuild the site contents using the `site` executable
+6. Check out the main branch
+7. Copy the `_site` directory over the `main` branch contents
+8. Commit and push the site contents to the `main` branch.
 
 ## License