From 50d65f693b7364aac95f1b8a1f5d492aa2f4725d Mon Sep 17 00:00:00 2001
From: Hendrik Kleinwaechter <hendrik.kleinwaechter@gmail.com>
Date: Fri, 4 Aug 2023 16:14:05 +0200
Subject: [PATCH] Improve website build documentation (#162)

This improves the documentation on how to build the website and applies
a couple of additional fixes. Followup to #161
---
 .github/workflows/release-website.yml |  2 +-
 makefile                              |  4 ----
 website/README.md                     | 22 ++++++++++++++++++++++
 3 files changed, 23 insertions(+), 5 deletions(-)
 create mode 100644 website/README.md

diff --git a/.github/workflows/release-website.yml b/.github/workflows/release-website.yml
index 705796d..84ad60f 100644
--- a/.github/workflows/release-website.yml
+++ b/.github/workflows/release-website.yml
@@ -31,7 +31,7 @@ jobs:
           image: ghcr.io/hendricius/the-sourdough-framework:latest
           options: -v ${{ github.workspace }}:/app
           run: |
-            cd /app/website
+            cd /app/book
             make website
       - name: Release baked website to S3
         uses: shallwefootball/s3-upload-action@master
diff --git a/makefile b/makefile
index a088a86..1e9b597 100644
--- a/makefile
+++ b/makefile
@@ -18,10 +18,6 @@ push_docker_image:
 
 .PHONY: website
 website: mrproper
-	docker run -it -v $(PWD):/opt/repo $(DOCKER_IMAGE) /bin/bash -c "cd /opt/repo/website && make website"
-
-.PHONY: latex_website
-latex_website: mrproper
 	docker run -it -v $(PWD):/opt/repo $(DOCKER_IMAGE) /bin/bash -c "cd /opt/repo/book && make website"
 
 .PHONY: validate
diff --git a/website/README.md b/website/README.md
new file mode 100644
index 0000000..ded96a9
--- /dev/null
+++ b/website/README.md
@@ -0,0 +1,22 @@
+# The Sourdough Framework website
+This code is responsible to generate the sourdough framework website.
+
+You can preview the website at [https://www.the-sourdough-framework.com](https://www.the-sourdough-framework.com/).
+
+## Installation
+
+Make sure you have ruby installed. The same version as listed in the `.ruby-version` file.
+
+## Building the website
+
+Go to the `../book` folder and run `make website`.
+
+If you want to run the post-processor only, run the processing script with:
+
+```bash
+bundle exec ruby modify_build.rb
+```
+
+## Viewing the website
+
+Go to the `static_website_html` folder and view the HTML files.