[FEAT] Better docs for developers

[tianhaoz95]

Overview

As of the writing of this issue, there are already awesome people who expressed interest in helping with the development of the app. However, the steps to do testing and also the overall code structure are not yet well documented which blocks many potential contributions. This issue aims to track the progress of adding content to the documentation and tooling. At the time this issue close, the project should achieve that contributors should be able to get hands-on development without any back and forth discussion, and the discussion can be better used for feature-specific or more interesting topics.

Roadmap

• Generate TS docs
  • Consider using mermaid for documenting #832
• Deploy to some repository gh-pages
• Add a link to the main repository readme docs
• Add a separate readme for dev docs
• Add a complete list of entry points
• Combine modules
  • Parser modules
  • Util modules (maybe rearrange)
• Better module naming and details #833
• Add instructions for doing development
  • Draft a skeleton for all the sections
  • Add docs for how to do unit tests and integration tests
  • Add docs for how to do end to end testing (this part is too complicated and has been delegated to [FEAT] E2E testing for contributors #830)