docs: update decision sidebar entries, add note to react doc

hotosm · Jan 13, 2025 · 23c8226 · 23c8226
1 parent 4506526
commit 23c8226
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 4 deletions.
diff --git a/docs/decisions/0003-react.md b/docs/decisions/0003-react.md
@@ -65,3 +65,12 @@ newly started projects.
   but also extends to the code complexity and ease of understanding / onboarding.
 - Bad, because we don't necessarily need a web framework for all our tools!
   We could probably build more resilient code using HTML with progressive enhancement.
+
+!!! note
+
+    With JavaScript being the language of web browsers, this page makes the
+    assumption that TypeScript is the general consensus best **language** to
+    be developing frontend software with.
+
+    However, do note that there are alternative approaches to typing, such
+    as JSDocs, but the goal of type safety is the same regardless.
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -141,10 +141,10 @@ nav:
           - Local Kubernetes: dev-guide/containers/kubernetes-local-kind.md
           - Production DB: dev-guide/containers/production-db.md
       - Tech Decisions:
-          - React: decisions/0003-react.md
-          - Python: decisions/0004-python.md
-          - Github: decisions/0005-github.md
-          - Slack: decisions/0006-slack.md
+          - Frontend framework: decisions/0003-react.md
+          - Backend language: decisions/0004-python.md
+          - Code hosting + CI/CD: decisions/0005-github.md
+          - Community engagement: decisions/0006-slack.md
           - Frontend dependencies: decisions/0007-pnpm.md
           - Backend dependencies: decisions/0008-uv.md
           - API Documentation: decisions/0002-mkdocs.md