Skip to content

[EPIC] Developer Document Improvement Plan  #91

@mave99a

Description

@mave99a

Goals

  • Well written, easy to understand, easy to hand on document to hep developers get started
  • A "Quick Start" one pager is included, it should be extremely simple and hand on. (Our ABT Node indeed is very simple)
    • Mac OS
    • Linux
    • Windows with Linux Subsystem
    • Docker
    • Start on Cloud Computing Platform, e.g. AWS, Windows Azure, etc.
    • Use ABT Node Launcher
  • A quick one pager to help user install a wallet which is necessary. We could have a more comprehensive wallet document in the future, but right now I think a one pager would be fine. In the future we can have links to full wallet document from this one pager.
  • A quick start to help user understand the concept and relationship of "Blocklet" and allow them to play with some ready made blocklets (How to use Blocklet is different from how to develop blocklet)
  • Separate Blocklet development document from ABT Node Document (In this document, we only explain the concept and how to use blocklet, but not how to develop it)
    Blocklet document is more focused on how to develop, debug, package and release a blocklet.
    ABT Node Document is more about how to install, use, manage and update ABT Node itself

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions