interbtc-docs

interBTC documentation for users, vaults, relayers, developers and anyone else.

About

This is the central place for user guides and links to developer documentation in the interBTC universe.

Getting Started

Prerequisites

Make sure you have yarn installed. Install docsify globally:

yarn global add docsify-cli

Installation

Clone the repository:

git clone git@github.com:interlay/interbtc-docs.git

Build the documentation:

docsify serve ./docs

Usage

You can browse the documentation locally or directly on docs.interlay.io.

Adding content

All pages are written using docsify. Follow their guide to add new pages: https://docsify.js.org/#/more-pages

Themes

The theme is based on docsify-themable and is very simple to customize: https://jhildenbiddle.github.io/docsify-themeable/#/customization

Contributions

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

Fork the Project
Create your Feature Branch (git checkout -b feature/AmazingFeature)
Commit your Changes (git commit -m 'feat: Add some AmazingFeature')
Push to the Branch (git push origin feature/AmazingFeature)
Open a Pull Request

We are using semantic versioning and conventional commits.

If you are searching for a place to start or would like to discuss features, reach out to us:

gregdhill/interbtc-docs