docs(adr): add ADR overview index page
Add an introductory index page explaining what ADRs are, why LUNA Charts uses them, and listing the currently documented decisions.
This commit is contained in:
@@ -0,0 +1,29 @@
|
||||
---
|
||||
title: "Architecture Decision Records"
|
||||
description: "Overview of the Architecture Decision Records (ADRs) for LUNA Charts."
|
||||
---
|
||||
|
||||
## What are ADRs?
|
||||
|
||||
An **Architecture Decision Record (ADR)** documents an important architectural decision along with its context, the alternatives considered, and the resulting consequences.
|
||||
|
||||
Instead of keeping knowledge only in the heads of individual maintainers, every decision is recorded in a traceable way: **why** it was made, **which options** were rejected, and **which trade-offs** were consciously accepted.
|
||||
|
||||
## Why do we use ADRs?
|
||||
|
||||
* **Traceability** – decisions remain understandable even years later.
|
||||
* **Onboarding** – new contributors quickly understand why the project is structured the way it is.
|
||||
* **Consistency** – future decisions can reference existing ADRs instead of repeating past discussions.
|
||||
* **Governance** – architectural changes happen deliberately, through a new ADR, rather than silently in the code.
|
||||
|
||||
## ADRs at LUNA Charts
|
||||
|
||||
LUNA Charts is an accessible, framework-agnostic charting library. Architectural decisions follow the phases of the **TOGAF Architecture Development Method (ADM)** and are continuously documented as ADRs – from repository structure to the technology stack to foundational principles such as accessibility.
|
||||
|
||||
The following ADRs have been documented so far:
|
||||
|
||||
* **ADR-0001** – Repository Structure
|
||||
* **ADR-0002** – Technology Stack
|
||||
* **ADR-0003** – Web Components as Public API
|
||||
* **ADR-0004** – SVG as Rendering Technology
|
||||
* **ADR-0005** – Accessibility as a Cross-Cutting Concern
|
||||
Reference in New Issue
Block a user