Skip to content

api3dao/vitepress-docs

Repository files navigation

API3 Technical Documentation

The technical documentation is maintained by the core technical team. Please feel free to create issues for discussions, proposals, additions, and changes in the repo vitepress-docs.

VitePress

The technical documentation has moved from VuePress to VitePress.

  • vitepress-docs: uses VitePress
  • api3-docs: uses VuePress

Firebase

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

Production

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

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