From 7fa7211d8eea9a988b86edb271b22b8117a82209 Mon Sep 17 00:00:00 2001 From: Ninosaurier Date: Wed, 15 Jul 2026 00:23:53 +0200 Subject: [PATCH] fix(docs): Migrate the first five ADRs --- docs/src/content/docs/adr/README.mdx | 29 ----- docs/src/content/docs/adr/index.mdx | 6 - docs/src/content/docs/adr/template.mdx | 120 ------------------ .../adr/000100-repository-structure.mdx | 2 +- .../adr/000200-technology-stack.mdx | 4 +- .../000300-web-components-as-public-api.mdx | 6 +- .../000400-svg-as-rendering-technology.mdx | 2 +- ...cessibility-as-a-cross-cutting-concern.mdx | 2 +- .../content/docs/getting-started/index.mdx | 2 +- 9 files changed, 9 insertions(+), 164 deletions(-) delete mode 100644 docs/src/content/docs/adr/README.mdx delete mode 100644 docs/src/content/docs/adr/index.mdx delete mode 100644 docs/src/content/docs/adr/template.mdx rename docs/src/content/docs/{ => architecture}/adr/000100-repository-structure.mdx (98%) rename docs/src/content/docs/{ => architecture}/adr/000200-technology-stack.mdx (97%) rename docs/src/content/docs/{ => architecture}/adr/000300-web-components-as-public-api.mdx (95%) rename docs/src/content/docs/{ => architecture}/adr/000400-svg-as-rendering-technology.mdx (97%) rename docs/src/content/docs/{ => architecture}/adr/000500-accessibility-as-a-cross-cutting-concern.mdx (97%) diff --git a/docs/src/content/docs/adr/README.mdx b/docs/src/content/docs/adr/README.mdx deleted file mode 100644 index fb05727..0000000 --- a/docs/src/content/docs/adr/README.mdx +++ /dev/null @@ -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 \ No newline at end of file diff --git a/docs/src/content/docs/adr/index.mdx b/docs/src/content/docs/adr/index.mdx deleted file mode 100644 index 535a308..0000000 --- a/docs/src/content/docs/adr/index.mdx +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: Architecture Decision Records -description: Read Architecture Decision Records ---- - -Welcome to the Architecture Decision Records! \ No newline at end of file diff --git a/docs/src/content/docs/adr/template.mdx b/docs/src/content/docs/adr/template.mdx deleted file mode 100644 index 4ccee8f..0000000 --- a/docs/src/content/docs/adr/template.mdx +++ /dev/null @@ -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 \ No newline at end of file diff --git a/docs/src/content/docs/adr/000100-repository-structure.mdx b/docs/src/content/docs/architecture/adr/000100-repository-structure.mdx similarity index 98% rename from docs/src/content/docs/adr/000100-repository-structure.mdx rename to docs/src/content/docs/architecture/adr/000100-repository-structure.mdx index 4ae6757..16515e6 100644 --- a/docs/src/content/docs/adr/000100-repository-structure.mdx +++ b/docs/src/content/docs/architecture/adr/000100-repository-structure.mdx @@ -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." --- diff --git a/docs/src/content/docs/adr/000200-technology-stack.mdx b/docs/src/content/docs/architecture/adr/000200-technology-stack.mdx similarity index 97% rename from docs/src/content/docs/adr/000200-technology-stack.mdx rename to docs/src/content/docs/architecture/adr/000200-technology-stack.mdx index aa5b400..e85861e 100644 --- a/docs/src/content/docs/adr/000200-technology-stack.mdx +++ b/docs/src/content/docs/architecture/adr/000200-technology-stack.mdx @@ -1,6 +1,6 @@ --- -title: "ADR-0002: Technology Stack" -description: "Auswahl des Technologie-Stacks für LUNA Charts basierend auf den TOGAF-Architekturprinzipien." +title: "ADR-0002000: Technology Stack" +description: "Selection of the technology stack for LUNA Charts based on the TOGAF architectural principles." --- * **Status:** Accepted diff --git a/docs/src/content/docs/adr/000300-web-components-as-public-api.mdx b/docs/src/content/docs/architecture/adr/000300-web-components-as-public-api.mdx similarity index 95% rename from docs/src/content/docs/adr/000300-web-components-as-public-api.mdx rename to docs/src/content/docs/architecture/adr/000300-web-components-as-public-api.mdx index 515155f..06c06ac 100644 --- a/docs/src/content/docs/adr/000300-web-components-as-public-api.mdx +++ b/docs/src/content/docs/architecture/adr/000300-web-components-as-public-api.mdx @@ -1,6 +1,6 @@ --- -title: "ADR-0003: Web Components as Public API" -description: "Entscheidung, die öffentliche API von LUNA Charts ausschließlich über Web Components bereitzustellen." +title: "ADR-0003000: Web Components as Public API" +description: "Decision to make LUNA Charts' public API available exclusively via Web Components." --- * **Status:** Accepted @@ -108,6 +108,6 @@ Framework wrappers remain lightweight integration layers and do not introduce ar ## References * LUNA Charts Architecture Wiki -* ADR-0002: Technology Stack +* ADR-0002000: Technology Stack * StencilJS Documentation * Web Components Specification \ No newline at end of file diff --git a/docs/src/content/docs/adr/000400-svg-as-rendering-technology.mdx b/docs/src/content/docs/architecture/adr/000400-svg-as-rendering-technology.mdx similarity index 97% rename from docs/src/content/docs/adr/000400-svg-as-rendering-technology.mdx rename to docs/src/content/docs/architecture/adr/000400-svg-as-rendering-technology.mdx index 9fb2845..2b3fefd 100644 --- a/docs/src/content/docs/adr/000400-svg-as-rendering-technology.mdx +++ b/docs/src/content/docs/architecture/adr/000400-svg-as-rendering-technology.mdx @@ -1,6 +1,6 @@ --- 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 diff --git a/docs/src/content/docs/adr/000500-accessibility-as-a-cross-cutting-concern.mdx b/docs/src/content/docs/architecture/adr/000500-accessibility-as-a-cross-cutting-concern.mdx similarity index 97% rename from docs/src/content/docs/adr/000500-accessibility-as-a-cross-cutting-concern.mdx rename to docs/src/content/docs/architecture/adr/000500-accessibility-as-a-cross-cutting-concern.mdx index 6a7fe7d..83b5dc8 100644 --- a/docs/src/content/docs/adr/000500-accessibility-as-a-cross-cutting-concern.mdx +++ b/docs/src/content/docs/architecture/adr/000500-accessibility-as-a-cross-cutting-concern.mdx @@ -1,6 +1,6 @@ --- 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 diff --git a/docs/src/content/docs/getting-started/index.mdx b/docs/src/content/docs/getting-started/index.mdx index 2e03b84..3943124 100644 --- a/docs/src/content/docs/getting-started/index.mdx +++ b/docs/src/content/docs/getting-started/index.mdx @@ -3,4 +3,4 @@ title: Getting Started description: Start here --- -Welcome to Getting Started! \ No newline at end of file +Welcome to Getting Test! \ No newline at end of file