-
-
Notifications
You must be signed in to change notification settings - Fork 1
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.
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
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR adds a new ARCHITECTURE.md file that documents the project architecture of DATEX Core and its relationship with other projects in the DATEX ecosystem.
- Introduces comprehensive architecture documentation describing core components (compiler, language server, runtime, libraries)
- Lists related projects that build on DATEX Core with links to their repositories
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| @@ -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. | |||
Copilot
AI
Dec 1, 2025
There was a problem hiding this comment.
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).
| 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. |
|
| Branch | doc/architecture |
| Testbed | ubuntu-latest |
Click to view all benchmark results
| Benchmark | Latency | Benchmark Result microseconds (µs) (Result Δ%) | Upper Boundary microseconds (µs) (Limit %) |
|---|---|---|---|
| dxb to json/test1.json | 📈 view plot 🚷 view threshold | 59.24 µs(-6.56%)Baseline: 63.40 µs | 69.25 µs (85.54%) |
| dxb to json/test2.json | 📈 view plot 🚷 view threshold | 12,069.00 µs(-8.02%)Baseline: 13,121.00 µs | 14,535.71 µs (83.03%) |
| dxb to json/test3.json | 📈 view plot 🚷 view threshold | 137,680.00 µs(-3.11%)Baseline: 142,094.29 µs | 149,630.55 µs (92.01%) |
| dxb to runtime value/test1.json | 📈 view plot 🚷 view threshold | 49.49 µs(+27.06%)Baseline: 38.95 µs | 52.73 µs (93.87%) |
| dxb to runtime value/test2.json | 📈 view plot 🚷 view threshold | 15,357.00 µs(+39.17%)Baseline: 11,034.43 µs | 16,729.98 µs (91.79%) |
| dxb to runtime value/test3.json | 📈 view plot 🚷 view threshold | 152,710.00 µs(+59.96%)Baseline: 95,466.14 µs | 169,095.16 µs (90.31%) |
| json to dxb/test1.json | 📈 view plot 🚷 view threshold | 6,298.00 µs(+334.51%)Baseline: 1,449.45 µs | 7,670.34 µs (82.11%) |
| json to dxb/test2.json | 📈 view plot 🚷 view threshold | 6,527,300.00 µs(+496.59%)Baseline: 1,094,094.29 µs | 8,064,848.07 µs (80.94%) |
| json to dxb/test3.json | 📈 view plot 🚷 view threshold | 38,630,000.00 µs(+439.54%)Baseline: 7,159,785.71 µs | 47,535,749.61 µs (81.27%) |
| json to runtime value datex auto static detection/test1.json | 📈 view plot 🚷 view threshold | 6,298.80 µs(+332.26%)Baseline: 1,457.16 µs | 7,668.96 µs (82.13%) |
| json to runtime value datex auto static detection/test2.json | 📈 view plot 🚷 view threshold | 6,554,100.00 µs(+494.20%)Baseline: 1,103,010.00 µs | 8,096,711.59 µs (80.95%) |
| json to runtime value datex auto static detection/test3.json | 📈 view plot 🚷 view threshold | 38,726,000.00 µs(+435.20%)Baseline: 7,235,842.86 µs | 47,637,425.13 µs (81.29%) |
| json to runtime value datex forced static/test1.json | 📈 view plot 🚷 view threshold | 6,354.20 µs(+335.51%)Baseline: 1,459.03 µs | 7,739.50 µs (82.10%) |
| json to runtime value datex forced static/test2.json | 📈 view plot 🚷 view threshold | 6,537,200.00 µs(+495.58%)Baseline: 1,097,618.57 µs | 8,076,554.07 µs (80.94%) |
| json to runtime value datex forced static/test3.json | 📈 view plot 🚷 view threshold | 38,688,000.00 µs(+438.26%)Baseline: 7,187,657.14 µs | 47,602,286.10 µs (81.27%) |
| json to runtime value datex/test1.json | 📈 view plot 🚷 view threshold | 6,278.50 µs(+330.42%)Baseline: 1,458.68 µs | 7,642.47 µs (82.15%) |
| json to runtime value datex/test2.json | 📈 view plot 🚷 view threshold | 6,551,300.00 µs(+492.46%)Baseline: 1,105,784.29 µs | 8,092,336.40 µs (80.96%) |
| json to runtime value datex/test3.json | 📈 view plot 🚷 view threshold | 38,744,000.00 µs(+433.82%)Baseline: 7,257,828.57 µs | 47,654,277.67 µs (81.30%) |
| json to runtime value json_syntax/test1.json | 📈 view plot 🚷 view threshold | 17.96 µs(-9.31%)Baseline: 19.80 µs | 22.34 µs (80.41%) |
| json to runtime value json_syntax/test2.json | 📈 view plot 🚷 view threshold | 5,876.60 µs(-9.03%)Baseline: 6,460.20 µs | 7,319.60 µs (80.29%) |
| json to runtime value json_syntax/test3.json | 📈 view plot 🚷 view threshold | 61,071.00 µs(-24.53%)Baseline: 80,919.86 µs | 106,485.76 µs (57.35%) |
| json to runtime value serde_json/test1.json | 📈 view plot 🚷 view threshold | 6.05 µs(-3.32%)Baseline: 6.26 µs | 6.62 µs (91.48%) |
| json to runtime value serde_json/test2.json | 📈 view plot 🚷 view threshold | 2,049.00 µs(-3.64%)Baseline: 2,126.43 µs | 2,233.36 µs (91.75%) |
| json to runtime value serde_json/test3.json | 📈 view plot 🚷 view threshold | 17,510.00 µs(+5.43%)Baseline: 16,608.57 µs | 18,554.08 µs (94.37%) |
| runtime init | 📈 view plot 🚷 view threshold | 12.64 µs(-90.71%)Baseline: 136.00 µs | 1,198.60 µs (1.05%) |
| runtime value to dxb/test1.json | 📈 view plot 🚷 view threshold | 6.96 µs(+82.19%)Baseline: 3.82 µs | 7.85 µs (88.67%) |
| runtime value to dxb/test2.json | 📈 view plot 🚷 view threshold | 2,209.00 µs(+109.06%)Baseline: 1,056.62 µs | 2,535.15 µs (87.13%) |
| runtime value to dxb/test3.json | 📈 view plot 🚷 view threshold | 22,419.00 µs(+110.47%)Baseline: 10,652.07 µs | 25,778.43 µs (86.97%) |
| runtime value to json datex/test1.json | 📈 view plot 🚷 view threshold | 66.21 µs(-2.64%)Baseline: 68.00 µs | 71.72 µs (92.31%) |
| runtime value to json datex/test2.json | 📈 view plot 🚷 view threshold | 14,784.00 µs(+2.90%)Baseline: 14,367.14 µs | 15,096.28 µs (97.93%) |
| runtime value to json datex/test3.json | 📈 view plot 🚷 view threshold | 156,650.00 µs(+1.54%)Baseline: 154,277.14 µs | 160,340.40 µs (97.70%) |
| runtime value to json json_syntax/test1.json | 📈 view plot 🚷 view threshold | 8.81 µs(-15.83%)Baseline: 10.47 µs | 12.61 µs (69.85%) |
| runtime value to json json_syntax/test2.json | 📈 view plot 🚷 view threshold | 3,798.40 µs(-14.60%)Baseline: 4,447.79 µs | 5,294.16 µs (71.75%) |
| runtime value to json json_syntax/test3.json | 📈 view plot 🚷 view threshold | 49,258.00 µs(-20.14%)Baseline: 61,680.86 µs | 78,907.84 µs (62.42%) |
| runtime value to json serde_json/test1.json | 📈 view plot 🚷 view threshold | 2.85 µs(-2.50%)Baseline: 2.93 µs | 3.31 µs (86.12%) |
| runtime value to json serde_json/test2.json | 📈 view plot 🚷 view threshold | 1,016.20 µs(+2.26%)Baseline: 993.72 µs | 1,161.48 µs (87.49%) |
| runtime value to json serde_json/test3.json | 📈 view plot 🚷 view threshold | 13,375.00 µs(+26.85%)Baseline: 10,543.99 µs | 14,737.52 µs (90.75%) |
No description provided.