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. Consider helping others and spread the usage of the SDK by providing the following documentation.

Readme

In your README, make sure that you at least have the following sections.

  • Requirements
  • Installation
  • Contributing
  • License

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. Research which is the reference generator most convenient for your language.

Guides

The NEM Developer Center gathers a collection of guides. These guides show developers how to use NEM built-in features while following step-by-step use cases. Each guide comes with at least one snippet, which is executable pieces of code that solve 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 nem2-docs repository.
git clone https://github.com/<YOUR_USERNAME>/nem2-docs.git
  1. Create a new folder under source/resources/examples/ named as the programming language of your SDK.
  2. Adapt every TypeScript snippet using the new SDK.
  3. Push the changes and create a pull request.