New paths and version for website

.github/workflows/vitepress-deploy.yml

@@ -10,10 +10,10 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - name: Checkout www repo
+    - name: Checkout website repo
       uses: actions/checkout@v4
       with:
-        path: fennecs-www
+        path: website
 
     - name: Checkout fennecs
       uses: actions/checkout@v4
@@ -35,21 +35,21 @@ jobs:
 
     - name: Install dependencies
       run: |
-        cd fennecs-www
+        cd website
         npm install
 
     - name: Build VitePress
       run: |
-        cd fennecs-www
+        cd website
         npm run build
 
     - name: Deploy to S3
       run: |
-        cd fennecs-www
+        cd website
         npm run upload
 
     - name: Invalidate CloudFront cache
       run: |
-        cd fennecs-www
+        cd website
         npm run invalidate
       

README.md

@@ -1,7 +1,7 @@
 # fennecs ECS documentation
-This is a vitepress project to create the website and documentation as seen on [fennecs.tech](https://fennecs.tech)
+This is a [VitePress](https://vitepress.dev) static site generator to create the website and documentation seen on [fennecs.tech](https://fennecs.tech)
 
-A GitHub action will integrate all changes made to `main` and deploy a new website.
+A GitHub action will integrate all changes made to `main` and deploy a new website to the appropriate S3 bucket.
 
 ## Developing
 ```bash
@@ -19,3 +19,7 @@ npm run upload
 npm run invalidate
 ```
 
+# Important
+To build the site, you also need [**fenn**ecs](https://github.com/outfox/fennecs) installed in the same parent directory as this project.
+
+This is necessary because the site includes source code snippets from fennecs during static sitegeneration.

package.json

@@ -1,7 +1,7 @@
 {
   "name": "fennecs.tech",
-  "version": "0.1.0",
-  "description": "fennecs Documentation",
+  "version": "0.2.0",
+  "description": "fennecs Documentation site",
   "main": "index.js",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
@@ -15,7 +15,7 @@
   "keywords": [
     "documentation"
   ],
-  "author": "Tiger Jove",
+  "author": "Moritz Voss",
   "license": "MIT",
   "devDependencies": {
     "markdown-it": "^14.1.0",