Syscoin Documentation

This repository contains two different kinds of documentation- API documentation for the Syscoin API and Syscoin Core as well as reference documentation for Syscoin Core.

Quick Reference

• Syscoin API Documentation
• Syscoin Reference Documentation

Note about API Docs

The API docs are generated from the OpenAPI specification defined in Syscoin API. The Syscoin API project is a Node/Express layer for interacting with Syscoin Core using REST. The same APIs are available via Syscoin Core directly using the built in RPC Server.

Building API Docs Locally

Prerequisites

You're going to need:

• Linux or OS X — Windows may work, but is unsupported.
• Ruby, version 2.3.1 or newer
• Bundler — If Ruby is already installed, but the bundle command doesn't work, just run gem install bundler in a terminal.

Getting Set Up

1. Fork this repository on GitHub.
2. Clone your forked repository (not our original one) to your hard drive with git clone https://github.com/YOURUSERNAME/syscoin-docs.git
3. cd syscoin-docs
4. Initialize and start Syscoin-docs. You can either do this locally, or with Vagrant:

# either run this to run locally
bundle install
bundle exec middleman server

# OR run this to run with vagrant
vagrant up

You can now see the docs at http://localhost:4567. Whoa! That was fast!

Converting OpenAPI to Markdown

For converting OpenAPI specs to Markdown the excellent Widdershins converter is suggested. The output should be saved to source/index.html.md.

Contributors

Improve these docs through pull requests to be added as a contributor.

Special Thanks

• Slate