Documentation Fixes#1983
Conversation
There was a problem hiding this comment.
3 issues found across 12 files
Confidence score: 3/5
- There is concrete user-facing risk in
docs/integrations/databases/surrealdb.md: examples and intro text reference non-existentSyncSurrealDB/AsyncSurrealDBclasses instead ofSurreal/AsyncSurreal, so readers are likely to hit immediate integration failures. docs/guides/web-ui/alerts.mdhas a docs-consistency gap (mentions email support without a documented Email channel), which can mislead setup expectations but is less severe than the SurrealDB mismatch.docs/integrations/event-streams/airflow.mdis missing EU endpoint guidance; this is a moderate regional correctness issue that could cause suboptimal or incorrect endpoint configuration for EU users.- Pay close attention to
docs/integrations/databases/surrealdb.md,docs/guides/web-ui/alerts.md, anddocs/integrations/event-streams/airflow.md- incorrect API names and missing/ambiguous guidance can directly mislead users during setup.
Prompt for AI agents (unresolved issues)
Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.
<file name="docs/guides/web-ui/alerts.md">
<violation number="1" location="docs/guides/web-ui/alerts.md:3">
P2: The description promises email support but no Email channel type is documented in the Notification Channels section. Either add the missing Email channel documentation or remove "email" from the description to avoid misleading readers.</violation>
</file>
<file name="docs/integrations/event-streams/airflow.md">
<violation number="1" location="docs/integrations/event-streams/airflow.md:31">
P2: Add a note that EU-region users should substitute `logfire-eu.pydantic.dev` for `logfire-us.pydantic.dev`. Without this, EU users following these docs may configure against the US endpoint, causing higher latency or service issues. Other docs in this PR (e.g., codex-logfire-exporter.md) include this note.</violation>
</file>
<file name="docs/integrations/databases/surrealdb.md">
<violation number="1" location="docs/integrations/databases/surrealdb.md:24">
P0: The class names `SyncSurrealDB` and `AsyncSurrealDB` do not exist in the `surrealdb` package. The actual exports are `Surreal` (sync) and `AsyncSurreal` (async). All code examples and the intro paragraph use incorrect import paths, which would cause `ImportError` for anyone following the documentation.</violation>
</file>
Reply with feedback, questions, or to request a fix.
Re-trigger cubic
| @@ -0,0 +1,79 @@ | |||
| --- | |||
There was a problem hiding this comment.
P0: The class names SyncSurrealDB and AsyncSurrealDB do not exist in the surrealdb package. The actual exports are Surreal (sync) and AsyncSurreal (async). All code examples and the intro paragraph use incorrect import paths, which would cause ImportError for anyone following the documentation.
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At docs/integrations/databases/surrealdb.md, line 24:
<comment>The class names `SyncSurrealDB` and `AsyncSurrealDB` do not exist in the `surrealdb` package. The actual exports are `Surreal` (sync) and `AsyncSurreal` (async). All code examples and the intro paragraph use incorrect import paths, which would cause `ImportError` for anyone following the documentation.</comment>
<file context>
@@ -0,0 +1,79 @@
+Call `logfire.instrument_surrealdb()` before creating any connections to automatically instrument all SurrealDB connection instances:
+
+```python skip-run="true" skip-reason="external-connection"
+from surrealdb import AsyncSurrealDB
+
+import logfire
</file context>
| --- | ||
| title: "Logfire Alerts: Status Monitoring & Error Notifications" | ||
| description: "Learn how to create alerts based on SQL query conditions (e.g., error count threshold). Use Logfire to track status changes and send notifications to Slack." | ||
| description: "Learn how to create alerts based on SQL query conditions (e.g., error count threshold). Use Logfire to track status changes and send notifications via Slack, Opsgenie, webhooks, or email." |
There was a problem hiding this comment.
P2: The description promises email support but no Email channel type is documented in the Notification Channels section. Either add the missing Email channel documentation or remove "email" from the description to avoid misleading readers.
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At docs/guides/web-ui/alerts.md, line 3:
<comment>The description promises email support but no Email channel type is documented in the Notification Channels section. Either add the missing Email channel documentation or remove "email" from the description to avoid misleading readers.</comment>
<file context>
@@ -1,6 +1,6 @@
---
title: "Logfire Alerts: Status Monitoring & Error Notifications"
-description: "Learn how to create alerts based on SQL query conditions (e.g., error count threshold). Use Logfire to track status changes and send notifications to Slack."
+description: "Learn how to create alerts based on SQL query conditions (e.g., error count threshold). Use Logfire to track status changes and send notifications via Slack, Opsgenie, webhooks, or email."
---
With **Logfire**, use Alerts to notify you when certain conditions are met.
</file context>
| [metrics] | ||
| otel_on = True | ||
| otel_host = logfire-api.pydantic.dev | ||
| otel_host = logfire-us.pydantic.dev |
There was a problem hiding this comment.
P2: Add a note that EU-region users should substitute logfire-eu.pydantic.dev for logfire-us.pydantic.dev. Without this, EU users following these docs may configure against the US endpoint, causing higher latency or service issues. Other docs in this PR (e.g., codex-logfire-exporter.md) include this note.
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At docs/integrations/event-streams/airflow.md, line 31:
<comment>Add a note that EU-region users should substitute `logfire-eu.pydantic.dev` for `logfire-us.pydantic.dev`. Without this, EU users following these docs may configure against the US endpoint, causing higher latency or service issues. Other docs in this PR (e.g., codex-logfire-exporter.md) include this note.</comment>
<file context>
@@ -28,15 +28,15 @@ Where `${LOGFIRE_TOKEN}` is your [**Logfire** write token][write-token].
[metrics]
otel_on = True
-otel_host = logfire-api.pydantic.dev
+otel_host = logfire-us.pydantic.dev
otel_port = 443
otel_prefix = airflow
</file context>
query-api.mdquery-api.mdlogfire-us/eu.pydantic.devquery-api.mdrow_oriented→json_rowsquery-api.mddeployment_environment+timezoneparamsalerts.mdclient-side-feature-flags.mdscrubbing.mdlogfire[._ -]?tokenpatternexplore.mddashboards.mdcli.mdauth logout,read-tokens create,run,prompt,infocodex-logfire-exporter.mdlogfire-us.pydantic.dev+ EU noteairflow.md,external.mdsurrealdb.md(new)mkdocs.yml