From 23c8226ee160241f80e1cda4ddf5e84e8e3435ea Mon Sep 17 00:00:00 2001 From: spwoodcock Date: Mon, 13 Jan 2025 11:33:12 +0000 Subject: [PATCH] docs: update decision sidebar entries, add note to react doc --- docs/decisions/0003-react.md | 9 +++++++++ mkdocs.yml | 8 ++++---- 2 files changed, 13 insertions(+), 4 deletions(-) diff --git a/docs/decisions/0003-react.md b/docs/decisions/0003-react.md index 810da53..03ce444 100644 --- 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 index d2d9f46..382c9a1 100644 --- 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