/docs

Introduction

Documentation contribution flow

Priorities can be found here in Pinned issues section. Please follow it.

When changes are made to Components, UI, general interaction flows, etc. They should be described in Blynk Documentation repository

Plus we have continuos existing documentation transfer case. To proceed with it:

  • find a file you know/created
  • check it's contents to be up-to-date with actual Blynk
  • put it to the corresponding directory or article of the new documentation
  • create pull request (let's keep main branch safe)

Documentation structure.

Keep to tree structure and mind that every entity should be described.

struc

There are Sections, Directories and Articles.

While we see Directories and Articles are displayed commonly in UI we have to keep in mind that in the terms of repository structure there's a difference:

We have Sign Up and Restore Password in Welcome Screen directory. Sign Up has two articles containing so it's directory while Restore Password is an end-point and it's article.

code-struc

While articles contents are stored inside *.md files description to directories should be put inside README.md inside the corresponding directory.

Article or Directory description formatting style

  • When writing an article explain each object giving maximum information shortly.
  • Use headers, paragraphs and lists to make it easier to read. Example
  • Provide the pictures in cases it can ease user's search of some specific buttons (such as Action, Tags or Map View buttons) or to give explanation to separate screen sections (such as Main Tabs switches, Devices List, Device View)

Link new Article or Directory to main structure

Once the Article or Directory description is written/added it should be linked inside SUMMARY.md so it can be uploaded and viewed om the Web.

To retrieve your *.md or directory path:

  • open it

  • click Action button

  • copy Path

    copy path

Edit SUMMARY.md by adding the relative link you got by following prevous steps to the file you've created following the markdown you'll see there.