From 8e2131ef129980c7de38b58255141ff6a7ff7c6c Mon Sep 17 00:00:00 2001 From: Ninosaurier Date: Wed, 15 Jul 2026 00:48:16 +0200 Subject: [PATCH] fix(docs): Added new chapter in the doc Added new chapter "getting-started", so new developers has a start point --- .../content/docs/getting-started/index.mdx | 41 ++++++++- .../getting-started/project-structure.mdx | 88 ++++++++++++++++++ .../content/docs/getting-started/roadmap.mdx | 92 +++++++++++++++++++ 3 files changed, 218 insertions(+), 3 deletions(-) create mode 100644 docs/src/content/docs/getting-started/project-structure.mdx create mode 100644 docs/src/content/docs/getting-started/roadmap.mdx diff --git a/docs/src/content/docs/getting-started/index.mdx b/docs/src/content/docs/getting-started/index.mdx index 3943124..340b739 100644 --- a/docs/src/content/docs/getting-started/index.mdx +++ b/docs/src/content/docs/getting-started/index.mdx @@ -1,6 +1,41 @@ --- -title: Getting Started -description: Start here +title: Why LUNA Charts? +description: Learn why LUNA Charts exists and what problems it aims to solve. +sidebar: + order: 0 --- -Welcome to Getting Test! \ No newline at end of file +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. + +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. + +## Project Goals + +LUNA Charts aims to provide a charting library that is: + +- Accessible by default +- Framework-independent through Web Components +- Easy to integrate into modern frontend frameworks +- Well documented for users and contributors +- Designed for long-term maintainability +- Governed through transparent architectural decisions + +## 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. + +## Learn More + +If you're interested in the project's design decisions, continue with the following sections: + +- **Project Structure** +- **Architecture** +- **Architecture Decision Records (ADRs)** \ No newline at end of file diff --git a/docs/src/content/docs/getting-started/project-structure.mdx b/docs/src/content/docs/getting-started/project-structure.mdx new file mode 100644 index 0000000..e67f462 --- /dev/null +++ b/docs/src/content/docs/getting-started/project-structure.mdx @@ -0,0 +1,88 @@ +--- +title: Project Structure +description: Overview of the LUNA Charts repository and its organization. +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. + +```text +luna-charts/ +│ +├── packages/ +│ └── luna-charts/ +│ +├── docs/ +│ +├── examples/ +│ +├── .github/ +│ +├── package.json +└── pnpm-workspace.yaml +``` + +## packages/ + +The `packages` directory contains the actual LUNA Charts library. + +This package is responsible for: + +- Chart components +- Rendering +- Public API +- Build process +- Testing + +As the project evolves, all chart implementations will live here. + +--- + +## docs/ + +The `docs` directory contains the complete project documentation. + +It serves as the **Single Point of Truth (SPOT)** for: + +- Architecture documentation +- Architecture Decision Records (ADRs) +- Developer guides +- Project governance +- User documentation + +The documentation is rendered using **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. + +Examples may include: + +- Vanilla JavaScript +- React +- Angular +- Vue + +--- + +## .github/ + +Contains project automation such as: + +- GitHub Actions +- Issue templates +- Pull request templates +- Community workflows + +--- + +## Monorepo + +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. + +As the project grows, additional packages or tooling may be introduced without changing the overall repository organization. \ No newline at end of file diff --git a/docs/src/content/docs/getting-started/roadmap.mdx b/docs/src/content/docs/getting-started/roadmap.mdx new file mode 100644 index 0000000..b8bd2f9 --- /dev/null +++ b/docs/src/content/docs/getting-started/roadmap.mdx @@ -0,0 +1,92 @@ +--- +title: Roadmap +description: Current project status and planned evolution of LUNA Charts. +sidebar: + order: 2 +--- + +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. + +--- + +## Current Status + +**Current Phase:** Groundwork + +The project is currently preparing the technical and organizational foundation for future development. + +Completed work includes: + +- Repository structure +- Development workflow +- Architecture documentation (TOGAF ADM) +- Architecture Decision Records (ADRs) +- Project governance +- Documentation infrastructure + +At this stage, no production-ready chart components are available. + +--- + +## Upcoming Milestones + +### Foundation + +- Create the initial StencilJS library +- Establish Storybook for component development +- Configure testing infrastructure +- Configure CI/CD pipeline + +--- + +### First Proof of Concept + +Deliver the first functional chart implementation to validate the technical architecture. + +Goals include: + +- SVG rendering +- Accessibility validation +- Framework integration +- Community feedback + +--- + +### Minimum Viable Product (MVP) + +Provide the first publicly usable version of LUNA Charts. + +The MVP focuses on delivering value rather than completeness. + +Expected outcomes include: + +- Initial chart collection +- Stable public API +- Documentation +- Example applications +- Accessibility support + +--- + +### Community Growth + +After the MVP, the project will gradually expand. + +Future work may include: + +- Additional chart types +- Advanced customization +- Performance improvements +- Extended framework support +- Community contributions +- Governance evolution + +--- + +## 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. \ No newline at end of file