Skip to content

Commit 7a99ee3

Browse files
docs(governance): sync documentation from governance@81806a2ec9032b47eed598590ae3df881f03580e
1 parent 371e0a5 commit 7a99ee3

File tree

2 files changed

+15
-17
lines changed

2 files changed

+15
-17
lines changed

docs/governance/CONTRIBUTING.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -58,12 +58,12 @@ To add a new vehicle to the dataset:
5858

5959
OpenEV Data consists of four repositories:
6060

61-
| Repository | Purpose | Primary Language |
62-
|:-----------|:--------|:-----------------|
63-
| [open-ev-data-dataset](https://github.com/open-ev-data/open-ev-data-dataset) | Vehicle data and JSON schemas | JSON |
64-
| [open-ev-data-api](https://github.com/open-ev-data/open-ev-data-api) | API engine and ETL pipeline | Rust |
65-
| [open-ev-data.github.io](https://github.com/open-ev-data/open-ev-data.github.io) | Documentation website | MkDocs |
66-
| [.github](https://github.com/open-ev-data/.github) | Governance and policies | Markdown |
61+
| Repository | Purpose | Primary Language |
62+
| :------------------------------------------------------------------------------- | :---------------------------- | :--------------- |
63+
| [open-ev-data-dataset](https://github.com/open-ev-data/open-ev-data-dataset) | Vehicle data and JSON schemas | JSON |
64+
| [open-ev-data-api](https://github.com/open-ev-data/open-ev-data-api) | API engine and ETL pipeline | Rust |
65+
| [open-ev-data.github.io](https://github.com/open-ev-data/open-ev-data.github.io) | Documentation website | MkDocs |
66+
| [.github](https://github.com/open-ev-data/.github) | Governance and policies | Markdown |
6767

6868
## Contributing to the Dataset
6969

@@ -138,7 +138,6 @@ Avoid:
138138

139139
- Rust 1.75+ installed via rustup
140140
- Understanding of REST APIs
141-
- Familiarity with WebAssembly (for edge deployments)
142141

143142
### Setup
144143

@@ -161,9 +160,8 @@ cargo test
161160
### Performance Considerations
162161

163162
- API targets <50ms response times globally
164-
- Optimize for edge runtime constraints
163+
- Optimize for production runtime constraints
165164
- Consider SQLite query performance
166-
- Minimize WASM binary size
167165

168166
## Contributing to Documentation
169167

docs/governance/index.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,20 @@
66
77
The primary goal of **OpenEV Data** is to develop and maintain the world's most accurate, scientifically validated, and accessible open database of Electric Vehicle (EV) specifications. Unlike fragmented proprietary lists, OpenEV is built on **Data-as-Code** principles, ensuring version control, strict schema validation, and community review for every data point—from battery chemistry to charging curves.
88

9-
Our infrastructure is powered by a high-performance **Rust** ecosystem. The API runs on the Edge (WebAssembly), providing global low-latency access to data, while the dataset itself is agnostic and available for direct download in JSON or SQL formats.
9+
Our infrastructure is powered by a high-performance **Rust** ecosystem. The API provides global low-latency access to data, while the dataset itself is agnostic and available for direct download in JSON or SQL formats.
1010

1111
We aim to speed up eMobility adoption by providing developers, researchers, and charging network operators with a reliable standard (The "OpenEV Spec") to build better routing algorithms, chargers, and apps.
1212

1313
## Repository Structure
1414

1515
OpenEV Data is modular by design to separate concerns between data curation and software engineering.
1616

17-
| Repository | Description | Tech Stack |
18-
| :----------------------------------------------------------------------------------- | :-------------------------------------------------------------------------- | :--------------------------------- |
19-
| [**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 |
17+
| Repository | Description | Tech Stack |
18+
| :----------------------------------------------------------------------------------- | :--------------------------------------------------------------------- | :---------------- |
19+
| [**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 API. | **Rust** |
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 |
2323

2424
## Getting Started
2525

@@ -38,7 +38,7 @@ To start consuming the data or contributing to the project, please read our [**D
3838

3939
- **Strict Typing:** All data is validated against rigorous JSON Schemas (`vehicle.schema.json`) before merging.
4040
- **Deep Merge Architecture:** Uses a hierarchical inheritance model (Base -> Year -> Trim) to ensure DRY (Don't Repeat Yourself) data entry.
41-
- **Edge Computing:** The API is deployed globally using Cloudflare Workers and D1 (SQLite), ensuring <50ms latency.
41+
- **High Performance:** The API is optimized for low-latency global access using efficient Rust infrastructure.
4242
- **Rust Core:** All tooling (ETL, Validation, Server) is written in Rust for safety and performance.
4343

4444
### Roadmap

0 commit comments

Comments
 (0)