READMEs & comments

Author: cephalin

.devcontainer/README.md

@@ -1,5 +1,9 @@
-# Dev container
+# .devcontainer directory
 
-This `.devcontainer` directory contains the configuration for a [dev container](https://docs.github.com/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers). It lets you open the repository in a [GitHub codespace](https://docs.github.com/codespaces/overview).
+This `.devcontainer` directory contains the configuration for a [dev container](https://docs.github.com/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers) and isn't used by the sample application.
 
-The dev container is configured to have the [Azure Developer CLI](https://learn.microsoft.com/azure/developer/azure-developer-cli/overview), so you can run `azd` commands directly.
+The dev container configuration lets you open the repository in a [GitHub codespace](https://docs.github.com/codespaces/overview) or a dev container in Visual Studio Code. For your convenience, the dev container is configured with the following:
+
+- Python
+- PostgreSQL
+- [Azure Developer CLI](https://learn.microsoft.com/azure/developer/azure-developer-cli/overview) (so you can run `azd` commands directly).

.devcontainer/devcontainer.json

@@ -51,7 +51,7 @@
 			}
 		}
 	},
-	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	// Use 'forwardPorts' to make a list of ports inside the container available locally. 5000 is for Flask, and 5432 is for PostgreSQL.
 	"forwardPorts": [
 		5000, 5432
 	],

.vscode/README.md

@@ -0,0 +1,3 @@
+# .vscode directory
+
+This `.vscode` directory contains configuration that lets you launch and debug in Visual Studio Code and isn't used by the sample application.

azure.yaml

@@ -1,4 +1,5 @@
 # yaml-language-server: $schema=https://raw.githubusercontent.com/Azure/azure-dev/main/schemas/v1.0/azure.yaml.json
+# azure.yaml is an azd configuration file and isn't used by the sample application. 
 
 name: flask-postgresql-sample-app
 metadata:

infra/README.md

@@ -0,0 +1,3 @@
+# infra directory
+
+This `infra` directory contains azd files used for `azd provision` and isn't used by the sample application.

startup.sh

@@ -1,3 +1,5 @@
+# startup.sh is used by infra/resources.bicep to automate database migrations and isn't used by the sample application
+
 flask db upgrade
 gunicorn --workers 2 --threads 4 --timeout 60 --access-logfile \
     '-' --error-logfile '-' --bind=0.0.0.0:8000 \