Commit ebe6f619 authored by David Trattnig's avatar David Trattnig
Browse files

Docs: Flesh out API and Doc

parent e8ff61f9
# Development
## Coding Conventions
## Coding Conventions and Guidelines
Here you find an overview of our conventions on coding and version control.
......@@ -29,6 +29,18 @@ We use [ESLint](https://eslint.org/) as the common Linter. When your code is bas
We utilize an *API-first* approach. APIs are specified using OpenAPI 3. Find the API at [api.aura.radio](https://api.aura.radio).
All the main aspects are documented within the spec. In some cases you may need some additional documentation in the docs. For example the [API: Schedules and conflict resolution](misc/conflict-resolution.md) document can be found in "*Developer Guide -> Misc*".
```{admonition} API-first
:class: tip
At the moment only [Engine API](https://api.aura.radio/engine) is based on API-first. [Steering API](https://api.aura.radio/steering) and [Tank API](https://api.aura.radio/tank) are momentarely generated out of the code base.
```
### Documentation
The general documentation is located in `meta/docs` and hosted at [docs.aura.radio](https://docs.aura.radio). When working on any component, also check if this documentation has to be updated or extended.
## Developer Installation
For Development the native installation as outlined in the `README` of individual [repositories](https://code.aura.radio) recommended.
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment