update docs

[eeliu]

Describe your changes

update docs

Issue ticket number and link

if it has issues, add them

Checklist before requesting a review

• I have performed a self-review of my code
• If it is a core feature, I have added thorough tests.
• Do we need to implement analytics?
• Will this be part of a product update? If yes, please write one phrase about this update.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 80.79%. Comparing base (5187cc0) to head (404e7a8).
Report is 6 commits behind head on dev.

Additional details and impacted files

@@           Coverage Diff           @@
##              dev     #646   +/-   ##
=======================================
  Coverage   80.79%   80.79%           
=======================================
  Files          22       22           
  Lines        1536     1536           
  Branches      165      165           
=======================================
  Hits         1241     1241           
  Misses        162      162           
  Partials      133      133           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.