Skip to content

Add project architecture documentation #517

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
benStre wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Add project architecture documentation #517

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions ARCHITECTURE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Project Architecture

This documents describes the general architecture of the DATEX Core Project, as well as the relationships with other projects in the DATEX ecosystem.
Copy link

Copilot AI Dec 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Grammatical error: "documents" should be "document" (singular).

Suggested change
This documents describes the general architecture of the DATEX Core Project, as well as the relationships with other projects in the DATEX ecosystem.
This document describes the general architecture of the DATEX Core Project, as well as the relationships with other projects in the DATEX ecosystem.

Copilot uses AI. Check for mistakes.

## Overview

The DATEX Core crate contains all fundamental building blocks of the DATEX runtime and language, including
* The DATEX compiler, that compiles DATEX source code into DXB (DATEX binary) format
* The DATEX language server, that provides IDE support for DATEX development
* The DATEX runtime, that executes DXB and handles communication, synchronization, storage etc.
* The DATEX core and std libraries
* Common traits for core communication interfaces (e.g. TCP, UDP, Serial, etc.)
* Default implementations for native platforms of communication interfaces, storage backends, and cryptographic methods

## Other Projects building on DATEX Core

We are currently actively developing several other projects that build on top of DATEX Core:
* **[DATEX Core JS](https://github.com/unyt-org/datex-core-js)**: A library that provides JavaScript bindings for DATEX Core via WebAssembly
* **[DATEX Core Embedded](https://github.com/unyt-org/datex-core-embedded)**: A wrapper around DATEX Core that provides default implementations for embedded targets such as ESP32
* **[DATEX CLI](https://github.com/unyt-org/datex-cli)**: A command-line interface for running DATEX code
Loading