SDK Documentation

SDKs need to be adopted by other developers. As a contributor, no one knows better than you how a determined SDK works. Provide the content for its documentation to help spread the use of your SDK.

Readme

Check if your repository has a complete Readme Notes. Consider using the template here used by some SDKs.

Required sections are the following:

  • Requirements
  • Installation
  • Contributing
  • License

Comments and Reference Docs

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

Some examples of reference generators are GoDoc for GO, whereas in Java we are using Javadoc. Research which is the reference generator most convenient for your language.

Guides

Sirius Developer Center gathers a collection of guides. They show developers how to use Sirius Chain built-in features while following step-by-step use cases.

Each guide comes with at least one snippet. Snippets are executable pieces of code that solve the proposed use case.

← SDK DevelopmentWallets & Explorers →