docs: record architecture decisions (#46)

* docs: keep markdown docs in source control

* docs: record architecture decisions

* chore: enforce markdownlint on *.md files

* docs: deploy ADRs to GitHub Pages

Author: brianrodri

.adr-dir

@@ -0,0 +1 @@
+docs/architecture/decisions

.gitignore

@@ -3,9 +3,14 @@ test-report.junit.xml
 tsconfig.tsbuildinfo
 coverage/
 dist/
-docs/
 node_modules/
 
+# Exclude generated doc files
+!docs/
+docs/*
+!docs/architecture/
+!docs/*.md
+
 # Exclude (most of) the testing vault
 !test-vault/
 test-vault/*

.markdownlint.json

@@ -0,0 +1,4 @@
+{
+    "$schema": "https://raw.githubusercontent.com/DavidAnson/markdownlint/refs/heads/main/schema/markdownlint-config-schema.json",
+    "extends": "markdownlint/style/prettier"
+}

docs/architecture/decisions/0001-record-architecture-decisions.md

@@ -0,0 +1,19 @@
+# 1. Record architecture decisions
+
+Date: 2025-03-06
+
+## Status
+
+Accepted
+
+## Context
+
+We need to record the architectural decisions made on this project.
+
+## Decision
+
+We will use Architecture Decision Records, as [described by Michael Nygard](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions).
+
+## Consequences
+
+See Michael Nygard's article, linked above. For a lightweight ADR toolset, see Nat Pryce's [adr-tools](https://github.com/npryce/adr-tools).