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

Next generation of api3-docs
https://github.com/api3dao/vitepress-docs

Last synced: 1 day ago
JSON representation

Next generation of api3-docs

• Host: GitHub
• URL: https://github.com/api3dao/vitepress-docs
• Owner: api3dao
• License: mit
• Created: 2022-09-14T16:59:47.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-11-08T12:18:01.000Z (7 days ago)
• Last Synced: 2024-11-08T13:25:18.524Z (7 days ago)
• Language: JavaScript
• Homepage: https://docs.api3.org/
• Size: 255 MB
• Stars: 11
• Watchers: 8
• Forks: 15
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# API3 Technical Documentation

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

## 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/.