Skip to content

Commit 8909936

Browse files
docs(governance): sync documentation from governance@
1 parent ee80cf9 commit 8909936

2 files changed

Lines changed: 27 additions & 19 deletions

File tree

docs/governance/GET_STARTED.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ npm install
100100
npm run validate
101101
```
102102

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).
104104

105105
### For API Developers
106106

@@ -112,7 +112,7 @@ cargo build
112112
cargo test
113113
```
114114

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).
116116

117117
### Quick Start with Docker
118118

@@ -191,7 +191,7 @@ For questions or issues:
191191

192192
- Open an issue in the relevant repository
193193
- Join discussions in [GitHub Discussions](https://github.com/orgs/open-ev-data/discussions)
194-
- Check existing [documentation](../index.md)
194+
- Check existing [documentation](https://open-ev-data.github.io)
195195

196196
---
197197

docs/governance/index.md

Lines changed: 24 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
# OpenEV Data
22

3-
<div align="center">
4-
<img src="../assets/images/open-ev-data-logo.svg" alt="OpenEV Data Logo" width="200" />
5-
</div>
3+
![OpenEV Data Logo](./assets/open-ev-data-logo.svg)
64

75
> **The Single Source of Truth for Electric Vehicle Specifications.**
86
@@ -16,19 +14,19 @@ We aim to speed up eMobility adoption by providing developers, researchers, and
1614

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

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 |
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 |
2523

2624
## Getting Started
2725

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).
2927

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.
3230

3331
## Project Status
3432

@@ -39,13 +37,13 @@ To start consuming the data or contributing to the project, please read our [**D
3937
### Technical Overview
4038

4139
- **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.
4341
- **Edge Computing:** The API is deployed globally using Cloudflare Workers and D1 (SQLite), ensuring <50ms latency.
4442
- **Rust Core:** All tooling (ETL, Validation, Server) is written in Rust for safety and performance.
4543

4644
### Roadmap
4745

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/).
4947

5048
### Supported Standards
5149
OpenEV Data standardizes specifications across multiple global charging standards:
@@ -61,10 +59,10 @@ OpenEV Data standardizes specifications across multiple global charging standard
6159

6260
We welcome contributions from EV enthusiasts, engineers, and manufacturers. Precision is our priority.
6361

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.
6563
- **To improve the API:** Please check the issues in the `open-ev-data-api` repository.
6664

67-
Read our [Contribution Guidelines](CONTRIBUTING.md) before submitting.
65+
Read our [Contribution Guidelines] before submitting.
6866

6967
## Governance & Licensing
7068

@@ -79,3 +77,13 @@ See [LICENSE](LICENSE) in each repository for specific details.
7977
## Support
8078

8179
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.
80+
81+
## Contributors
82+
83+
| Avatar | Contributor | Contributions |
84+
| :-----------------------------------------------------------------------------: | :------------------------------------: | :------------------------------------------ |
85+
| <img src="https://github.com/jsrwell.png" width="50" style="border-radius:50%"> | [@jsrwell](https://github.com/jsrwell) | Project creator, architecture, API, dataset |
86+
87+
---
88+
89+
[Contribution Guidelines]: CONTRIBUTING.md

0 commit comments

Comments
 (0)