chore(release): prepare v0.1.0 release for main #16

Merged
Ninosaurier merged 90 commits from dev into main 2026-08-05 15:57:47 +00:00
9 changed files with 9 additions and 164 deletions
Showing only changes of commit 7fa7211d8e - Show all commits
-29
View File
@@ -1,29 +0,0 @@
---
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
-6
View File
@@ -1,6 +0,0 @@
---
title: Architecture Decision Records
description: Read Architecture Decision Records
---
Welcome to the Architecture Decision Records!
-120
View File
@@ -1,120 +0,0 @@
---
title: "ADR-XXXXXX: Title"
description: "One-sentence summary of the decision."
---
* **Status:** Proposed
* **Date:** YYYY-MM-DD
* **Decision Makers:** LUNA Charts Maintainers
---
## Context
Describe the background that led to this decision.
Questions that should be answered:
* What problem needs to be solved?
* Which architectural constraints exist?
* Which project goals influence the decision?
* Which stakeholders are affected?
---
## Decision Drivers
List the primary factors that influenced the decision.
Typical examples:
* Accessibility
* Performance
* Developer Experience
* Maintainability
* Framework Agnosticism
* Type Safety
* Simplicity
* Scalability
---
## Considered Alternatives
Document all relevant alternatives.
| Alternative | Description |
| ----------- | ----------- |
| Option A | Description |
| Option B | Description |
| Option C | Description |
Briefly explain why the alternatives were not selected.
---
## Decision
Describe the selected solution.
This section should clearly answer:
> What has been decided?
---
## Rationale
Explain why the selected solution best satisfies the decision drivers.
This section should justify the decision from an architectural perspective.
---
## Consequences
### Positive
Describe the expected benefits.
Examples:
* Improved maintainability
* Better accessibility
* Easier onboarding
* Reduced complexity
### Negative
Describe possible drawbacks.
Examples:
* Increased implementation effort
* Additional maintenance
* Performance trade-offs
---
## Related TOGAF Phases
List all architecture phases that influenced this decision.
Examples:
* Architecture Vision (Phase A)
* Technology Architecture (Phase D)
* Implementation Governance (Phase G)
---
## References
Provide references to related documentation.
Examples:
* Architecture Wiki
* Other ADRs
* External standards
* Specifications
@@ -1,5 +1,5 @@
--- ---
title: "ADR-0001: Repository Structure" title: "ADR-0001000: Repository Structure"
description: "Decision to use a pnpm-based monorepo structure for LUNA Charts." description: "Decision to use a pnpm-based monorepo structure for LUNA Charts."
--- ---
@@ -1,6 +1,6 @@
--- ---
title: "ADR-0002: Technology Stack" title: "ADR-0002000: Technology Stack"
description: "Auswahl des Technologie-Stacks für LUNA Charts basierend auf den TOGAF-Architekturprinzipien." description: "Selection of the technology stack for LUNA Charts based on the TOGAF architectural principles."
--- ---
* **Status:** Accepted * **Status:** Accepted
@@ -1,6 +1,6 @@
--- ---
title: "ADR-0003: Web Components as Public API" title: "ADR-0003000: Web Components as Public API"
description: "Entscheidung, die öffentliche API von LUNA Charts ausschließlich über Web Components bereitzustellen." description: "Decision to make LUNA Charts' public API available exclusively via Web Components."
--- ---
* **Status:** Accepted * **Status:** Accepted
@@ -108,6 +108,6 @@ Framework wrappers remain lightweight integration layers and do not introduce ar
## References ## References
* LUNA Charts Architecture Wiki * LUNA Charts Architecture Wiki
* ADR-0002: Technology Stack * ADR-0002000: Technology Stack
* StencilJS Documentation * StencilJS Documentation
* Web Components Specification * Web Components Specification
@@ -1,6 +1,6 @@
--- ---
title: "ADR-000400: SVG as Rendering Technology" title: "ADR-000400: SVG as Rendering Technology"
description: "Entscheidung, SVG als Rendering-Technologie für alle Chart-Visualisierungen in LUNA Charts einzusetzen." description: "Decision to use SVG as the rendering technology for all chart visualizations in LUNA Charts."
--- ---
* **Status:** Accepted * **Status:** Accepted
@@ -1,6 +1,6 @@
--- ---
title: "ADR-000500: Accessibility as a Cross-Cutting Concern" title: "ADR-000500: Accessibility as a Cross-Cutting Concern"
description: "Entscheidung, Accessibility als Cross-Cutting Concern über alle Architekturebenen von LUNA Charts zu behandeln." description: "Decision to treat accessibility as a cross-cutting concern across all architectural layers of LUNA Charts."
--- ---
* **Status:** Accepted * **Status:** Accepted
@@ -3,4 +3,4 @@ title: Getting Started
description: Start here description: Start here
--- ---
Welcome to Getting Started! Welcome to Getting Test!