electrode-io / livebundle

LiveBundle CLI

Home Page:https://www.livebundle.io/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

ISS basic documentation

belemaire opened this issue · comments

For ISS release, need to have a basic documentation ready for initial users.

This documentation should only cover the client side of LiveBundle as the back end / infra side will be created and maintained by our team.

Basically what we want here is starter basic client documentation to :

  • Add LiveBundle to an React Native application repository
  • Configure LiveBundle client (livebundle.yaml client config overview)
  • Setup LiveBundle in the native application codebase (initialization on iOS/Android)
  • How to push and retrieve bundles from the application

Basically, all that's needed to setup and use LiveBundle in an internal Walmart React Native application repository.

This documentation should not be part of the public website/documentation repository, as it will be made available prior to OSS release, so the website will not be launched / completed yet. Also, even though most of this documentation will not greatly differ from OSS documentation, we could have some instructions that are specific to Walmart environment (for example directly providing IP address of backend, and maybe some VPN setup if needed). So probably documentation on Confluence. That being said, I expect 90% of this documentation to be reused as-is for the public documentation (so moved to the public website documentation prior to OSS release).