docs: Edit API docs

[crandmck]

Changes in this pull request

Doc-only changes:

• Hide some stuff that we don't want people to use but that we are not yet ready to remove or deprecate.
• Clean up example code and text
• Open questions and tasks are marked as "TO DO" in code comments and I've tagged people in PR comments.

Additional things for @gpeacock :

• Review modules and see what can be removed now.
• Double-check that ResourceStore needs to be public, maybe hide it?
• Can we hide DefaultOptions ?
• Can we hide IngredientOptions?

Do these need to be public?

• BoxedAsyncSigner
• BoxedSigner

[codspeed-hq]

CodSpeed Performance Report

Merging this PR will not alter performance

_{Comparing docs/api-doc-updates (26a2de5) with main (41faabd)}

Summary

✅ 16 untouched benchmarks
⏩ 2 skipped benchmarks¹

Footnotes

1. 2 benchmarks were skipped, so the baseline results were used instead. If they were deleted from the codebase, click here and archive them to remove them from the performance reports. ↩

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 75.72%. Comparing base (41faabd) to head (26a2de5).

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #1772   +/-   ##
=======================================
  Coverage   75.72%   75.72%           
=======================================
  Files         168      168           
  Lines       39002    39002           
=======================================
  Hits        29535    29535           
  Misses       9467     9467           

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

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.