Compare commits
2
Commits
dev
...
3bb9c1f6fb
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
3bb9c1f6fb | ||
|
|
4033aba10a |
@@ -0,0 +1,37 @@
|
||||
<!-- markdownlint-disable MD041 -->
|
||||
## Goal
|
||||
|
||||
<!-- One sentence: what should this issue achieve? -->
|
||||
|
||||
## Description
|
||||
|
||||
<!-- Context and background: why is this issue necessary?
|
||||
What is the current state, and what is missing or needs to be done? -->
|
||||
|
||||
## Steps to Reproduce
|
||||
|
||||
<!-- Only relevant for bugs — remove this section for tasks/features.
|
||||
1. Go to '...'
|
||||
2. Click on '...'
|
||||
3. See error -->
|
||||
|
||||
## Expected Behaviour
|
||||
|
||||
<!-- Only relevant for bugs — what should have happened? -->
|
||||
|
||||
## Actual Behaviour
|
||||
|
||||
<!-- Only relevant for bugs — what happened instead? -->
|
||||
|
||||
## Tasks
|
||||
|
||||
- [ ] ...
|
||||
- [ ] ...
|
||||
- [ ] ...
|
||||
- [ ] Update the related parts of the documentation
|
||||
|
||||
## Acceptance Criteria
|
||||
|
||||
- ...
|
||||
- ...
|
||||
- ...
|
||||
@@ -0,0 +1,34 @@
|
||||
<!-- markdownlint-disable MD041 -->
|
||||
## Description
|
||||
|
||||
<!-- What does this PR change and why? -->
|
||||
|
||||
## Related Issue
|
||||
|
||||
<!-- Closes #... / Relates to #... -->
|
||||
|
||||
## Type of Change
|
||||
|
||||
- [ ] Bug fix
|
||||
- [ ] New feature
|
||||
- [ ] Refactoring (no functional changes)
|
||||
- [ ] Documentation
|
||||
- [ ] Tests
|
||||
|
||||
## Changes
|
||||
|
||||
- ...
|
||||
- ...
|
||||
- ...
|
||||
|
||||
## How Has This Been Tested?
|
||||
|
||||
<!-- Describe how you verified your changes (unit tests, manual testing, etc.) -->
|
||||
|
||||
## Checklist
|
||||
|
||||
- [ ] Code follows the project's style guidelines
|
||||
- [ ] Self-review of the code has been performed
|
||||
- [ ] Tests have been added/updated and pass locally
|
||||
- [ ] Documentation has been updated where necessary
|
||||
- [ ] No new warnings or errors introduced
|
||||
@@ -5,13 +5,22 @@ sidebar:
|
||||
order: 0
|
||||
---
|
||||
|
||||
LUNA Charts is an open-source charting library built with a strong focus on **accessibility**, **developer experience**, and **long-term maintainability**.
|
||||
LUNA Charts is an open-source charting library built with a strong focus on **accessibility**, **developer experience**, and
|
||||
**long-term maintainability**.
|
||||
|
||||
The project was created because many existing charting libraries provide excellent visualizations, but often treat accessibility, architecture, and maintainability as secondary concerns.
|
||||
The project was created because many existing charting libraries provide excellent visualizations but often
|
||||
treat accessibility as a secondary concern. Furthermore, a lot of teams have a lack of accessibility awareness,
|
||||
and accessibility features are often pushed to the end of the project.
|
||||
|
||||
LUNA Charts takes a different approach.
|
||||
|
||||
Instead of starting with code, the project started with an **architecture-first process**. The entire foundation—including business goals, technical architecture, governance, and architectural decisions—was designed before implementation began.
|
||||
Instead of focusing on becoming a big library with numerous chart-creation functions, this project concentrates
|
||||
on ease of use and chart modification, with accessibility playing a major role throughout the entire development process.
|
||||
LUNA-Charts is open-source software.
|
||||
This guarantees that everyone can use and modify it. We want to make the world more accessible for everyone.
|
||||
|
||||
Furthermore, we focus on an **architecture-first process**. The entire foundation—including
|
||||
business goals, technical architecture, governance, and architectural decisions—was designed before implementation began.
|
||||
|
||||
## Project Goals
|
||||
|
||||
@@ -26,11 +35,9 @@ LUNA Charts aims to provide a charting library that is:
|
||||
|
||||
## Current Project Status
|
||||
|
||||
The project is currently in the **Groundwork** phase.
|
||||
|
||||
At this stage, the architecture, repository structure, development workflow, and governance model are being established before implementing the first chart components.
|
||||
|
||||
Although no production-ready charts are available yet, the project documentation already reflects the long-term vision and architectural direction.
|
||||
The project is currently in the **First Proof of Concept (v0.3.0)** phase.
|
||||
We validate the core technical and accessibility assumptions of the library through a first working implementation.
|
||||
The goal is to prove that the chosen architecture actually works in practice before committing to a broader component set.
|
||||
|
||||
## Learn More
|
||||
|
||||
|
||||
@@ -5,7 +5,8 @@ sidebar:
|
||||
order: 1
|
||||
---
|
||||
|
||||
LUNA Charts follows a modular repository structure that separates the chart library from its documentation while keeping all project artifacts within a single repository.
|
||||
LUNA Charts follows a modular repository structure that separates the chart library from its documentation while keeping
|
||||
all project artifacts within a single repository.
|
||||
|
||||
```text
|
||||
luna-charts/
|
||||
@@ -51,31 +52,38 @@ It serves as the **Single Point of Truth (SPOT)** for:
|
||||
- Project governance
|
||||
- User documentation
|
||||
|
||||
The documentation is rendered using **Starlight**, but the Markdown content remains the authoritative source.
|
||||
The documentation is rendered using **Astro and Starlight**, but the Markdown content remains the authoritative source.
|
||||
|
||||
---
|
||||
|
||||
## examples/
|
||||
|
||||
Example applications demonstrating how to integrate LUNA Charts with supported frontend frameworks will be added here in future iterations.
|
||||
Example applications demonstrating how to integrate LUNA Charts with supported frontend frameworks
|
||||
will be added here in future iterations.
|
||||
|
||||
Examples may include:
|
||||
|
||||
- Vanilla JavaScript
|
||||
- React
|
||||
- Angular
|
||||
- Vue
|
||||
|
||||
Right now, we are working on version 0.3.0, implementing a first proof of concept.
|
||||
The first Minimum Viable Product will be launched with version 1.0.0.
|
||||
|
||||
---
|
||||
|
||||
## .gitea/
|
||||
|
||||
- Gitea Actions
|
||||
- Issue templates
|
||||
- Pull request templates
|
||||
- Community workflows
|
||||
|
||||
## .github/
|
||||
|
||||
Contains project automation such as:
|
||||
|
||||
- GitHub Actions
|
||||
- Issue templates
|
||||
- Pull request templates
|
||||
- Community workflows
|
||||
- Code of Conduct
|
||||
|
||||
---
|
||||
|
||||
@@ -83,6 +91,7 @@ Contains project automation such as:
|
||||
|
||||
LUNA Charts is maintained as a **pnpm workspace**.
|
||||
|
||||
This structure allows multiple packages and supporting projects to evolve together while sharing a consistent toolchain and development workflow.
|
||||
This structure allows multiple packages and supporting projects to evolve together while sharing a consistent
|
||||
toolchain and development workflow.
|
||||
|
||||
As the project grows, additional packages or tooling may be introduced without changing the overall repository organization.
|
||||
@@ -7,7 +7,9 @@ sidebar:
|
||||
|
||||
LUNA Charts follows an **architecture-first** development approach.
|
||||
|
||||
Instead of implementing features immediately, the project establishes a solid architectural and organizational foundation before writing production code. This ensures long-term maintainability, consistent quality, and transparent decision-making.
|
||||
Instead of implementing features immediately, the project establishes a solid architectural and organizational
|
||||
foundation before writing production code. This ensures long-term maintainability, consistent quality, and
|
||||
transparent decision-making.
|
||||
|
||||
---
|
||||
|
||||
@@ -20,7 +22,7 @@ Instead of implementing features immediately, the project establishes a solid ar
|
||||
Completed work includes:
|
||||
|
||||
- **Repository structure:** Standardized layout for code, configurations, and assets.
|
||||
- \*\*Development workflow: Definition of branching strategies, commit rules, and review processes.
|
||||
- **Development workflow:** Definition of branching strategies, commit rules, and review processes.
|
||||
- **Architecture documentation (TOGAF ADM):** Architecture framework set up according to the TOGAF standard.
|
||||
- **Architecture Decision Records (ADRs 1-5):** System established for transparent documentation of architectural decisions.
|
||||
- **Project governance:** Defined roles, responsibilities, and decision-making processes.
|
||||
@@ -102,6 +104,5 @@ Future work may include:
|
||||
|
||||
## Long-Term Vision
|
||||
|
||||
LUNA Charts aims to become an accessible, framework-independent charting library that combines modern Web Components with a transparent architecture and a sustainable open-source development model.
|
||||
|
||||
Every milestone builds upon the architectural foundation established during the Groundwork phase.
|
||||
LUNA Charts aims to become an accessible, framework-independent charting library that combines modern Web Components with a
|
||||
transparent architecture and a sustainable open-source development model.
|
||||
|
||||
Reference in New Issue
Block a user