You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/governance/GET_STARTED.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -100,7 +100,7 @@ npm install
100
100
npm run validate
101
101
```
102
102
103
-
Read the [Dataset Architecture](../dataset/ARCHITECTURE.md) and [Schema Documentation](../dataset/SCHEMA.md).
103
+
Read the [Dataset Architecture](https://github.com/open-ev-data/open-ev-data-dataset/blob/main/docs/ARCHITECTURE.md) and [Schema Documentation](https://github.com/open-ev-data/open-ev-data-dataset/blob/main/docs/SCHEMA.md).
104
104
105
105
### For API Developers
106
106
@@ -112,7 +112,7 @@ cargo build
112
112
cargo test
113
113
```
114
114
115
-
Read the [API Architecture](../api/ARCHITECTURE.md).
115
+
Read the [API Architecture](https://github.com/open-ev-data/open-ev-data-api/blob/main/ARCHITECTURE.md).
116
116
117
117
### Quick Start with Docker
118
118
@@ -191,7 +191,7 @@ For questions or issues:
191
191
192
192
- Open an issue in the relevant repository
193
193
- Join discussions in [GitHub Discussions](https://github.com/orgs/open-ev-data/discussions)
Copy file name to clipboardExpand all lines: docs/governance/index.md
+24-16Lines changed: 24 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,6 @@
1
1
# OpenEV Data
2
2
3
-
<divalign="center">
4
-
<imgsrc="../assets/images/open-ev-data-logo.svg"alt="OpenEV Data Logo"width="200" />
5
-
</div>
3
+

6
4
7
5
> **The Single Source of Truth for Electric Vehicle Specifications.**
8
6
@@ -16,19 +14,19 @@ We aim to speed up eMobility adoption by providing developers, researchers, and
16
14
17
15
OpenEV Data is modular by design to separate concerns between data curation and software engineering.
18
16
19
-
| Repository | Description | Tech Stack |
20
-
| :--- | :--- | :--- |
21
-
|[**open-ev-data-dataset**](https://github.com/open-ev-data/open-ev-data-dataset)| The core database. Contains all vehicle JSONs and validation schemas. | JSON, JSON Schema |
22
-
|[**open-ev-data-api**](https://github.com/open-ev-data/open-ev-data-api)| The high-performance engine. Handles ETL, SQL generation, and the Edge API. |**Rust**, Wasm, Cloudflare Workers |
23
-
|[**open-ev-data.github.io**](https://github.com/open-ev-data/open-ev-data.github.io)| Official documentation, guides, and API reference. | MkDocs, Material |
24
-
|[**.github**](https://github.com/open-ev-data/.github)| Governance, organization-wide policies, and issue templates. | Markdown |
|[**open-ev-data-dataset**](https://github.com/open-ev-data/open-ev-data-dataset)| The core database. Contains all vehicle JSONs and validation schemas. | JSON, JSON Schema|
20
+
|[**open-ev-data-api**](https://github.com/open-ev-data/open-ev-data-api)| The high-performance engine. Handles ETL, SQL generation, and the Edge API. |**Rust**, Wasm, Cloudflare Workers |
21
+
|[**open-ev-data.github.io**](https://github.com/open-ev-data/open-ev-data.github.io)| Official documentation, guides, and API reference. | MkDocs, Material|
22
+
|[**.github**](https://github.com/open-ev-data/.github)| Governance, organization-wide policies, and issue templates. | Markdown|
25
23
26
24
## Getting Started
27
25
28
-
To start consuming the data or contributing to the project, please read our [**Documentation**](../index.md).
26
+
To start consuming the data or contributing to the project, please read our [**Documentation**](https://open-ev-data.github.io).
29
27
30
-
-**For Data Scientists:** Clone [open-ev-data-dataset](https://github.com/open-ev-data/open-ev-data-dataset) to access raw JSON files or see our [Dataset Documentation](../dataset/index.md).
31
-
-**For Developers:** Check the [API Documentation](../api/index.md) to integrate OpenEV into your app.
28
+
-**For Data Scientists:** Clone [open-ev-data-dataset](https://github.com/open-ev-data/open-ev-data-dataset) to access raw JSON files.
29
+
-**For Developers:** Check the [API Reference](https://open-ev-data.github.io/api) to integrate OpenEV into your app.
32
30
33
31
## Project Status
34
32
@@ -39,13 +37,13 @@ To start consuming the data or contributing to the project, please read our [**D
39
37
### Technical Overview
40
38
41
39
-**Strict Typing:** All data is validated against rigorous JSON Schemas (`vehicle.schema.json`) before merging.
42
-
-**Deep Merge Architecture:** Uses a hierarchical inheritance model (Base → Year → Trim) to ensure DRY (Don't Repeat Yourself) data entry.
40
+
-**Deep Merge Architecture:** Uses a hierarchical inheritance model (Base -> Year -> Trim) to ensure DRY (Don't Repeat Yourself) data entry.
43
41
-**Edge Computing:** The API is deployed globally using Cloudflare Workers and D1 (SQLite), ensuring <50ms latency.
44
42
-**Rust Core:** All tooling (ETL, Validation, Server) is written in Rust for safety and performance.
45
43
46
44
### Roadmap
47
45
48
-
See our technical roadmap on our [project website](../index.md).
46
+
See our technical roadmap on our [project website](https://open-ev-data.github.io/roadmap/).
49
47
50
48
### Supported Standards
51
49
OpenEV Data standardizes specifications across multiple global charging standards:
@@ -61,10 +59,10 @@ OpenEV Data standardizes specifications across multiple global charging standard
61
59
62
60
We welcome contributions from EV enthusiasts, engineers, and manufacturers. Precision is our priority.
63
61
64
-
-**To add a vehicle:** Please open a Pull Request in the `open-ev-data-dataset` repository using the provided templates. See our [Contributing Guide](CONTRIBUTING.md).
62
+
-**To add a vehicle:** Please open a Pull Request in the `open-ev-data-dataset` repository using the provided templates.
65
63
-**To improve the API:** Please check the issues in the `open-ev-data-api` repository.
66
64
67
-
Read our [Contribution Guidelines](CONTRIBUTING.md) before submitting.
65
+
Read our [Contribution Guidelines] before submitting.
68
66
69
67
## Governance & Licensing
70
68
@@ -79,3 +77,13 @@ See [LICENSE](LICENSE) in each repository for specific details.
79
77
## Support
80
78
81
79
If you identify a data error or a bug in the API, please [open an issue](https://github.com/open-ev-data/.github/issues) using the appropriate template.
0 commit comments