docs(performance): wire SDK performance guide into README + docs nav (#26)

[karlwaldman]

Closes #26

What

The SDK Performance Guide content already existed at docs/PERFORMANCE_GUIDE.md, but it was undiscoverable: the README did not link to it, and it was absent from the mkdocs site navigation. This PR makes the guide reachable and locks all five acceptance criteria behind executable documentation-contract tests so they cannot silently regress.

Changes are additive and minimal:

• README.md — add a "Performance Guide" link in the Documentation section.
• mkdocs.yml — add the guide to the docs site nav.
• tests/unit/test_performance_docs.py — new documentation-contract tests (TDD) asserting the guide exists, documents expected response times / recommended timeouts, best practices (pagination, async, context managers), a troubleshooting section, runnable code examples, a README link, and nav discoverability.

Acceptance criteria (#26)

• Performance guide added to docs (docs/PERFORMANCE_GUIDE.md)
• Best practices documented
• Troubleshooting guide added
• Examples updated with performance notes
• README links to performance guide

TDD evidence

Test written before the implementation. Red → green:

RED (before fix):

FAILED tests/unit/test_performance_docs.py::test_readme_links_to_performance_guide
FAILED tests/unit/test_performance_docs.py::test_performance_guide_in_mkdocs_nav
2 failed, 5 passed

GREEN (after fix):

tests/unit/test_performance_docs.py .......                              [100%]
7 passed

Full gate (matches CI .github/workflows/test.yml)

ruff check oilpriceapi/      -> All checks passed!
mypy oilpriceapi/            -> Success: no issues found in 43 source files
pytest (unit, not slow)      -> 318 passed, 9 skipped; coverage 59.33% (>= 50% gate)

No changes to migrations, Stripe, auth, routes, or marketing copy.

🤖 Generated with Claude Code

[coderabbitai]

Warning

Review limit reached

@karlwaldman, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 39 minutes and 11 seconds. Learn how PR review limits work.

Your organization has used up its prepaid credits, and credit purchases are no longer available. Enable the review add-on in the billing tab to keep reviews running — you're only billed for reviews past your plan's rate limits ($0.25/file).

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based credits.

🚦 How do rate limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan refill rate.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, the refill rate gradually slows as usage increases. The highest same-day bursts are limited more strictly.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 8fdfa630-5b8a-46fd-8d9c-bbf1a8241129

📥 Commits

Reviewing files that changed from the base of the PR and between 7c7b777 and 29eddc4.

📒 Files selected for processing (3)

• README.md
• mkdocs.yml
• tests/unit/test_performance_docs.py

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch sprint-loop/issue-26

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}