-
Notifications
You must be signed in to change notification settings - Fork 188
Small fixes for logfire docs #1582
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR addresses multiple documentation issues across the Logfire documentation, including typos, incorrect code examples, missing imports, and incorrect API references. The changes improve code runnability and documentation accuracy.
- Fixed broken code examples by adding missing imports, variables, and required parameters
- Corrected spelling and grammar errors throughout the documentation
- Fixed incorrect API class names and outputs to match actual behavior
Reviewed changes
Copilot reviewed 15 out of 15 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| docs/why.md | Corrected output example to show 'USA' instead of 'US' |
| docs/reference/self-hosted/scaling.md | Fixed typos: 'minAvaliable' → 'minAvailable' and 'depenent' → 'dependent' |
| docs/reference/self-hosted/overview.md | Fixed product name typo: 'Logifre' → 'Logfire' |
| docs/reference/self-hosted/local-quickstart.md | Fixed typo: 'enterpirse' → 'enterprise' |
| docs/integrations/web-frameworks/index.md | Removed extraneous closing parenthesis |
| docs/integrations/llms/llamaindex.md | Removed duplicate text in OpenAI documentation reference |
| docs/integrations/llms/anthropic.md | Corrected class names from 'AmazonBedrock' to 'AnthropicBedrock' |
| docs/integrations/index.md | Fixed FastAPI example by adding required imports and app parameter |
| docs/integrations/http-clients/httpx.md | Added missing client instantiation to make example runnable |
| docs/how-to-guides/suppress.md | Added missing HTTPX link reference definition |
| docs/how-to-guides/alternative-backends.md | Fixed 'Jager' → 'Jaeger' spelling in image alt texts (2 occurrences) |
| docs/guides/web-ui/issues.md | Removed duplicate word 'issues' |
| docs/guides/onboarding-checklist/add-metrics.md | Added missing imports, corrected Observable → Observation, added Linux-specific warning |
| docs/guides/onboarding-checklist/add-auto-tracing.md | Added required min_duration parameter |
| docs/concepts.md | Fixed grammar: 'A metric a calculated' → 'A metric is a calculated' |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
Thanks! |
|
this is amazing, thank you @strawgate! We should definitely find a way to run all examples in this repo with pytest-examples, like we do for pydantic and pydantic-ai, even if we don't test the generated otel data - just running the examples would have caught lots of these cases. |
Closes: #1581
app. https://logfire.pydantic.dev/docs/integrations/ should match https://logfire.pydantic.dev/docs/integrations/web-frameworks/fastapi/#usagemin_durationparameter https://logfire.pydantic.dev/docs/guides/onboarding-checklist/add-auto-tracing/#filtering-modules-to-trace[httpx]https://logfire.pydantic.dev/docs/how-to-guides/suppress/#suppress-scopesLogfireis typo'd https://logfire.pydantic.dev/docs/reference/self-hosted/overview/Dependentis typo'd https://logfire.pydantic.dev/docs/reference/self-hosted/scaling/)https://logfire.pydantic.dev/docs/integrations/web-frameworks/#excluding-urls-from-instrumentationminAvaliable: 1https://logfire.pydantic.dev/docs/reference/self-hosted/scaling/#scaling-configurationisin "A metric a calculated value measuring..." in concepts.md https://logfire.pydantic.dev/docs/concepts/ isissues"Sort by First Seen - youngest <> oldest issues issues" in issues.md for webui https://logfire.pydantic.dev/docs/guides/web-ui/issues/ contains