[WIP] warehouse: docs

[atravitz]

Checklist

• All new code is appropriately documented (user-facing code must have complete docstrings).
• Added a news entry, or the changes are not user-facing.
• Ran pre-commit: you can run pre-commit locally or comment on this PR with pre-commit.ci autofix.

Manual Tests: these are slow so don't need to be run every commit, only before merging and when relevant changes are made (generally at reviewer-discretion).

• GPU integration tests
• example notebook testing
• packaging tests: run this for any large feature PRs or PRs that add test data.

Developers certificate of origin

• I certify that this contribution is covered by the MIT License here and the Developer Certificate of Origin at https://developercertificate.org/.

[github-actions]

No API break detected ✅

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.34%. Comparing base (7ec596b) to head (6ebdebb).

Additional details and impacted files

@@                Coverage Diff                 @@
##           feat/warehouse    #1988      +/-   ##
==================================================
+ Coverage           90.33%   90.34%   +0.01%     
==================================================
  Files                 212      212              
  Lines               20086    20092       +6     
==================================================
+ Hits                18144    18152       +8     
+ Misses               1942     1940       -2     

Flag	Coverage Δ
fast-tests	90.34% <100.00%> (+0.01%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 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.

[atravitz]

I know Required is the default, but can we be explicit here for the sake of documentation?

Also, do we want to actually validate this? Otherwise it won't fail until there's a key error when someone tries to access .result_store.

[atravitz]

what is the plan for this?