Writing a guide

Thank you for considering writing a new guide!

Before starting

  1. Open the nem2-docs repository issues, and find some ideas pending to be written. They have the label “great new issue”.
  2. Opt to contribute to one of them by adding a comment, or create a new issue with your guide idea.
  3. Classify your guide under one of the following categories:
  • Account
  • Account Filter
  • Aggregate Transaction
  • Block
  • Cross-Chain Swaps
  • Harvesting
  • Mosaic
  • Namespace
  • Node
  • Receipt
  • Transfer Transaction
  • Tools

Note

You can suggest new categories creating a GitHub issue.

Writing the guide

  1. Fork and clone the nem2-docs repository.
git clone <url>
  1. Make sure you have Python 2.7 or 3.4+ and pip installed.
python --version
  1. Install requirements using pip:
pip install -r requirements.txt
  1. Create a new rst file inside one of the guides folder,
mkdir source/guides/<folder_name>/<title>.rst
  1. Use the following template to organize your content.
:orphan:

.. post:: 18 Aug, 2018
    :category: <category>
    :excerpt: 1
    :nocomments:
    :author: <your_name_or_username>

#####
Title
#####

Objective after finishing the guide.

**********
Background
**********

Explain necessary concepts before starting to code.

*************
Prerequisites
*************

- A
- B
- C

**********************
Getting into some code
**********************

Present the code and step-by-step explanation.

************
What's next?
************

Is there any extra exercise that readers could try on their own?
  1. Write and code your guide! Check the restructured text cheatsheet to style your text.
  2. Add the code examples under source/resources/examples/<language_or_tool>. You can render fragments of code from a file inside your rst file.
.. example-code::

    .. viewsource:: <relative_url>.ts
        :language: typescript
        :start-after:  /* start block 01*/
        :end-before: /* end block 01 */
  1. Test and preview your changes.

    make livehtml

  2. Push your changes and do a pull-request. The repository maintainers will proofread and edit the content to follow the documentation writing style.