docs: Improve @fluidframework/test-client-utils API docs

[Josmithr]

Improve @fluidframework/test-client-utils API docs

The intention behind this PR is to improve API documentation on the consumer-facing APIs of the @fluidframework/test-client-utils package. It also includes some changes in transitively exposed APIs from packages upon which it depends.

See here for the public-facing, generated docs: https://fluidframework.com/docs/apis/test-client-utils/

The TODOs and comments I left are in search of suggestions from area experts. If you are reviewing this and know of someone who would have expertise and/or opinions on the docs, please feel free to tag them :)

ADO #643

[skylerjokiel]

🚀

[skylerjokiel]

1 more recommendation

[github-actions]

🔗 Found some broken links! 💔

Run a link check locally to find them. See
https://github.com/microsoft/FluidFramework/wiki/Checking-for-broken-links-in-the-documentation for more information.

linkcheck output

> [email protected] linkcheck /home/runner/work/FluidFramework/FluidFramework/docs
> npm run linkcheck:fast -- --external


> [email protected] linkcheck:fast /home/runner/work/FluidFramework/FluidFramework/docs
> linkcheck http://localhost:1313 --skip-file skipped-urls.txt "--external"

Crawling...

http://localhost:1313/css/style.min.f22f6c22fcc37a0d857a17c9c1202a67c28deef90cc26a52b7539b903f623331.css
- (1:1031) url(...) => https://c.s-microsoft.com/static/fonts/segoe-ui/west-european/light/latest.svg (HTTP 503)
- (1:1272) url(...) => https://c.s-microsoft.com/static/fonts/segoe-ui/west-european/semilight/latest.eot? (HTTP 503)
- (1:1634) url(...) => https://c.s-microsoft.com/static/fonts/segoe-ui/west-european/semilight/latest.ttf (HTTP 503)
- (1:1740) url(...) => https://c.s-microsoft.com/static/fonts/segoe-ui/west-european/semilight/latest.svg (HTTP 503)
- (1:2427) url(...) => https://c.s-microsoft.com/static/fonts/segoe-ui/west-european/normal/latest.svg (HTTP 503)
- (1:3130) url(...) => https://c.s-microsoft.com/static/fonts/segoe-ui/west-european/semibold/latest.svg (HTTP 503)
- (1:3286) url(...) => https://c.s-microsoft.com/static/fonts/segoe-ui/west-european/bold/latest.eot (HTTP 503)
- (1:3710) url(...) => https://c.s-microsoft.com/static/fonts/segoe-ui/west-european/bold/latest.ttf (HTTP 503)
- (1:3811) url(...) => https://c.s-microsoft.com/static/fonts/segoe-ui/west-european/bold/latest.svg (HTTP 503)


Stats:
   14095 links
     296 destination URLs
       1 URLs ignored
       0 warnings
       9 errors

[github-actions]

This commit is queued for merging with the next branch! Please ignore this PR for now. Contact @microsoft/fluid-cr-infra for help.