An open API service indexing awesome lists of open source software.

https://github.com/api3dao/airnode-docs

Airnode and OIS docs
https://github.com/api3dao/airnode-docs

Last synced: 11 months ago
JSON representation

Airnode and OIS docs

Awesome Lists containing this project

README

          

# API3 Airnode Technical Documentation

The Airnode technical documentation is maintained by the core technical team.
Please feel free to create
[issues](https://github.com/api3dao/airnode-docs/issues) for discussions,
proposals, additions, and changes in the repo `airnode-docs`.

## VitePress

The technical documentation has moved from
[VuePress](https://vuepress.vuejs.org) to
[VitePress](https://vitepress.vuejs.org).

- `airnode-docs`: uses VitePress
- `old-api3-docs`: uses VuePress

## Firebase

Firebase is used to host the `airnode-docs` technical documentation.

### Production

- DNS: https://airnode-docs.api3.org
- Hosted with Firebase: https://vitepress-docs.web.app

### Previews

Additionally each PR has its own Firebase preview site. The URL will be
available in the PR's comments.

## Making a Contribution

Please see [CONTRIBUTING.md](CONTRIBUTING.md) for details on how to make a
contribution.

## Legacy documentation

The original documentation for the repo `api3-docs` is now accessible via
https://old-docs.api3.org and is still hosted using `gh-pages`.

- DNS: http://old-docs.api3.org
- Hosted with GitHub: https://api3dao.github.io/api3-docs

## /dev/ docset

Use https://docs.api3.org/dev/ to learn more about how the `airnode-docs`
documentation is managed. For the legacy documentation use
https://old-docs.api3.org/dev/.