Skip to content

Documentation Fixes#1983

Draft
strawgate wants to merge 1 commit into
mainfrom
docs/documentation-audit-fixes
Draft

Documentation Fixes#1983
strawgate wants to merge 1 commit into
mainfrom
docs/documentation-audit-fixes

Conversation

@strawgate

Copy link
Copy Markdown
Contributor
Fix File Change
1 query-api.md Default limit 500 → 100
2 query-api.md Intro URL → regional logfire-us/eu.pydantic.dev
3 query-api.md row_orientedjson_rows
4, 5 query-api.md Added deployment_environment + timezone params
6, 7, 8, 14 alerts.md Full rewrite: 6 channel types (Slack BlockKit/Legacy, Opsgenie, Webhook auto/raw, Email), Schedules section, Watermark section
9 client-side-feature-flags.md OFREP URL → regional
10 scrubbing.md Added missing logfire[._ -]?token pattern
11 explore.md Added 5 missing metrics columns
12 dashboards.md Added Gauge as Time Series Query (corrected from the original commit which had it wrong)
13 cli.md Documented auth logout, read-tokens create, run, prompt, info
15 codex-logfire-exporter.md URL → logfire-us.pydantic.dev + EU note
16, 17 airflow.md, external.md Already correct in main — changes backfill earlier referenced text
18 surrealdb.md (new) Created SurrealDB integration page + added to mkdocs.yml

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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-existent SyncSurrealDB/AsyncSurrealDB classes instead of Surreal/AsyncSurreal, so readers are likely to hit immediate integration failures.
  • docs/guides/web-ui/alerts.md has 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.md is 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, and docs/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 @@
---

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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."

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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>

@strawgate strawgate marked this pull request as draft June 1, 2026 11:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant