Merge pull request #29 from uktrade/docs/detail-on-uses

docs: repository layout

README.md

@@ -6,13 +6,44 @@
 
 ---
 
-This is the entry-point repository for Data Workspace, a PostgreSQL-based open source data analysis platform with features for users with a range of technical skills. It contains a brief catalogue of all Data Workspace repositories, the source for the [Data Workspace developer documentation](https://data-workspace.docs.trade.gov.uk/), and the Terraform code to deploy Data Workspace into AWS.
+This is the entry-point repository for Data Workspace, a PostgreSQL-based open source data analysis platform with features for users with a range of technical skills. It contains a brief catalogue of all Data Workspace repositories (below), the source for the [Data Workspace developer documentation](https://data-workspace.docs.trade.gov.uk/), and the Terraform code to deploy Data Workspace into AWS.
 
 > [!TIP]
 > Looking for the Data Workspace Django application? It's now in the [data-workspace-frontend repo](https://github.com/uktrade/data-workspace-frontend).
 
+---
+
+### Repository contents
+
+- [docs/](./docs/)
+
+   The source of the [Data Workspace developer documentation](https://data-workspace.docs.trade.gov.uk/). The documentation is built using the node-based [Eleventy static site generator](https://www.11ty.dev/) and the [X-GOV https://x-govuk.github.io/govuk-eleventy-plugin/](govuk-eleventy-plugin) in order to use the GOV.UK design system.
+
+   The built documentation is hosted on [GitHub pages](https://pages.github.com/).
+
+- [infra/](./infra/)
+
+   The [Terraform](https://www.terraform.io/) source to build the infrastructure of Data Workspace in Amazon Web Services (AWS).
+
+- [package-lock.json](./package-lock.json)
+
+   The list of specific versions of all the direct and transitive node dependencies needed to build the Data Workspace developer documentation.
 
-## Catalogue of Data Workspace repositories
+- [package.json](./package.json)
+
+   The list of the direct node dependencies needed to build the Data Workspace developer documentation.
+
+- [eleventy.config.js](./eleventy.config.js)
+
+   The configuration for the Data Workspace developer documentation.
+
+- [README.md](./README.md)
+
+   The source of the file you're currently reading.
+
+---
+
+### Catalogue of Data Workspace repositories
 
 The components of Data Workspace are stored across several Git repositories.
 
@@ -55,4 +86,3 @@ Some of the components of Data Workspace are lower level, and less Data Workspac
 - [ecs-pipeline](https://github.com/uktrade/ecs-pipeline)
 
    Used to deploy Data Workspace from Jenkins
-