Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README and cleanup #11

Merged
merged 2 commits into from
Jun 21, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file removed Archive.zip
Binary file not shown.
52 changes: 9 additions & 43 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,47 +1,13 @@
# API3 Technical Documentation
# OEV docs preview

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

## VitePress

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

- `vitepress-docs`: uses VitePress
- `api3-docs`: uses VuePress
This technical documentation is a fork of the official
[API3 technical documentation](https://docs.api3.org). The intent is to develop
OEV-related documentation here privately then merge into the official repo when
ready.

## Firebase

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

### Production

- DNS: https://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 `vitepress-docs`
documentation is managed. For the legacy documentation use
https://old-docs.api3.org/dev/.
Firebase is used to host the `oev-docs` technical documentation. A preview
deployment is generated for every PR, while the main deployment is updated with
every merge to the `main` branch. The url for the main deployment is:
[https://oev-docs.web.app](https://oev-docs.web.app).
44 changes: 0 additions & 44 deletions archives/.vitepress/chains.json

This file was deleted.

12 changes: 0 additions & 12 deletions archives/.vitepress/versionsAirnodeLegacy.json

This file was deleted.

7 changes: 0 additions & 7 deletions archives/README.md

This file was deleted.

151 changes: 0 additions & 151 deletions archives/SearchHighlight-org.vue

This file was deleted.

26 changes: 0 additions & 26 deletions archives/_components/ChainName.vue

This file was deleted.

1 change: 0 additions & 1 deletion archives/_components/ExternalLinkImage.vue

This file was deleted.

7 changes: 0 additions & 7 deletions archives/_components/InfoBtnBlue.vue

This file was deleted.

Loading
Loading