SDK Documentation

The SDKs need to be adopted by other developers, and as a contributor, no one knows better than you how a determined SDK works. Help others and spread the usage of the SDK writing documentation.

Readme

Make sure that the README has the following sections.

  • Requirements

  • Installation

  • Contributing

  • License

Template: README

Comments and reference docs

Document functions and classes with comments while you write your code. A reference generator should be able to read these comments and generate HTML as an output.

Some examples of reference generators are TypeDoc for Javascript, whereas in Java, we are using Javadoc.

We recommend you to research and determine which is the reference generator most convenient for the selected programming language.

Guides

The Bitxor Developer Documentation gathers a collection of guides. These guides show developers how to use Bitxor built-in features while following step-by-step use cases. Each guide comes with at least one snippet, which is an executable piece of code that solves the proposed use case.

Writing snippets helps you to compare how the SDK code looks like in contrast with others. Furthermore, you will be testing manually if the SDK behaves correctly.

  1. Fork and clone symbl-docs repository.

    git clone https://github.com/<YOUR_USERNAME>/bitxor-docs.git

  2. Create a new folder under source/resources/examples/ named as the programming language of your SDK.

  3. Adapt every TypeScript snippet using the new SDK.

  4. Push the changes and create a pull request.