Skip to content

Missing Setup Documentation #294

@lucspec

Description

@lucspec

User Story

I recently got a new phone, and when I went to set up my nebula app I had some difficulty remembering the process. It would be nice to have a little more clear instruction on how to set up a phone. The current README is pretty developer focused and doesn't make it easy for end users to onboard.

Recommendation

Reorganize the README a bit. I thought of a few options that keep the value of the developer docs while improving the onboarding experience and put them below.

  • Option 1: developer-focused README.md with a GETTING_STARTED.md linked
  • Option 2: onboarding-focused README.md with a DEVELOPERS.md for setting up a build environment

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