Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[EPIC] Developer Document Improvement Plan #91

Open
11 tasks
mave99a opened this issue May 6, 2021 · 0 comments
Open
11 tasks

[EPIC] Developer Document Improvement Plan #91

mave99a opened this issue May 6, 2021 · 0 comments

Comments

@mave99a
Copy link

mave99a commented May 6, 2021

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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant