Merge pull request #159 from AmpersandTarski/documentation

Documentation

.devcontainer/devcontainer.json

@@ -4,24 +4,21 @@
 	"name": "PHP",
 	"build": {
 		"dockerfile": "Dockerfile",
-		"args": { 
+		"args": {
 			// Update VARIANT to pick a PHP version: 8, 8.1, 8.0, 7, 7.4
 			// Append -bullseye or -buster to pin to an OS version.
 			// Use -bullseye variants on local on arm64/Apple Silicon.
 			"VARIANT": "8.1",
 			"NODE_VERSION": "none"
 		}
 	},
-
 	"mounts": [
 		"source=${localWorkspaceFolder}/.devcontainer/php.ini,target=/usr/local/etc/php/php.ini,type=bind,consistency=cached"
 	],
-
 	// Set *default* container specific settings.json values on container create.
-	"settings": { 
+	"settings": {
 		"php.validate.executablePath": "/usr/local/bin/php"
 	},
-
 	// Add the IDs of extensions you want installed when the container is created.
 	"extensions": [
 		// "felixfbecker.php-debug",
@@ -30,14 +27,15 @@
 		"mehedidracula.php-namespace-resolver",
 		"neilbrayfield.php-docblocker",
 		"ikappas.phpcs",
+		"mhutchie.git-graph",
+		"donjayamanne.githistory"
 	],
-
 	// Use 'forwardPorts' to make a list of ports inside the container available locally.
-	"forwardPorts": [8080],
-
+	"forwardPorts": [
+		8080
+	],
 	// Use 'postCreateCommand' to run commands after the container is created.
 	// "postCreateCommand": "sudo chmod a+x \"$(pwd)\" && sudo rm -rf /var/www/html && sudo ln -s \"$(pwd)\" /var/www/html"
-
 	// Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
 	"remoteUser": "vscode"
-}
+}

.github/workflows/trigger-docs-update.yml

@@ -4,7 +4,7 @@ name: Trigger Documentation Update
 on:
   push:
     branches:
-    - main
+      - main
     paths:
     - 'docs/**'
 

docs/README.md

@@ -1,5 +1,6 @@
 ---
 title: The Prototype Framework
+id: prototype-framework
 ---
 
 # Ampersand prototype framework
@@ -8,10 +9,3 @@ title: The Prototype Framework
 
 ## Introduction
 This documentation is intended for developers of the framework and more advanced users of Ampersand and the prototype framework. It explains the key concepts, classes and project setup.
-
-## Table of content
-1. [Configuration of the prototype](./config.md)
-1. [File system / storage implementation](./file-system.md)
-1. [Event dispatcher](./event-dispatcher.md)
-1. [Interface templates](./interface-templates.md)
-1. [Generics folder](./generics.md)