ガイドを記述する

Symbol Developer Documentation このガイドは、他の開発者が Symbol のテクノロジーを使い始めるのに役立ち、ツールの使用方法、他のテクノロジーとの統合方法、および組み込み機能をアーキテクトソリューションに組み合わせる方法について段階的に説明しています。

始める前に

ガイドを書くためのインスピレーションを探している場合は、 symbol-docs リポジトリの未解決の問題 を参照して、執筆中のアイデアを見つけることができます。または、私達の Slack ＃sig-docs チャンネルに参加して、自己紹介をすると良いでしょう。

既存の問題の 1 つと協力するには、重複した作業を避けるためにコメントで表現してください。まだ問題の登録が無い場合は、公開するコンテンツを紹介する新しい問題を作成します。

ガイドを記述する

  1. https://help.github.com/articles/fork-a-repo/ をフォークして`symbol-docs <https://github.com/nemtech/symbol-docs>`_ リポジトリをクローンしてください。

     git clone https://github.com/nemtech/symbol-docs.git

  2. Python 3.4+ と pip がインストールされていることを確認してください。

     python --version

  3. pipを使用した要求環境のインストール

     pip install -r requirements.txt

  4. ガイドのフォルダ内に新しく rst を作成します。

     mkdir source/guides/<folder_name>/<title>.rst

  5. restructuredText でガイドを作成してコーディングします。テキストのフォーマットについてヘルプが必要な場合は、この チートシート を参照してください。

    あなたのコンテンツの整理にこのテンプレートを使用できます:

     .. post:: 18 Aug, 2018
    :category: <category>
    :excerpt: 1
    :nocomments:
    :author: <your_name_or_username>
#####
Title
#####
The objective to achieve after finishing the guide.
********
Use case
********
Explain the 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?

  6. コード例 を source/resources/examples/<language_or_tool> の下に追加してください。example-code ディレクティブで .rst ファイルの中からコード断片をレンダリングすることもできます。

     .. example-code::
   .. viewsource:: <relative_url>.ts
       :language: typescript
       :start-after:  /* start block 01*/
       :end-before: /* end block 01 */

  7. あなたの変更点をテストしプレビューしてください。

     make livehtml

8. Push your changes and create a pull-request. The repository maintainers will proofread and edit the content to follow the documentation style guide.