We need detailed documentations and examples

[dousha]

No description provided.

[dousha]

We do have inline documentation for exposed methods. Run yarn doc will generate the inline document. We will publish it to gh-pages or some documentation hosting service later.

[dousha]

The documentation is now published to GitHub Repo Pages. Most of the inline documentation works fine. However, the enum values are not recognized by JSDoc properly. They are emitting as undefined values or just plainly not shown.

The inline documentation is now available in Chinese only. JSDoc doesn't seem to have proper i18n support. We may need to figure that out later or switch to a different documentation service.