docs(observe): Observe section revamp (chunk 1)#701
Open
khushalsonawat wants to merge 4 commits into
Open
Conversation
…ers, voice) First chunk of the Observe revamp, stacked on the product dropdown reorder. Adds the Observe > Concepts pages as Explanation-mode docs, plus the Mermaid rendering support they depend on, and repoints the Observe > Concepts sidebar to them. - New concept pages: spans, traces, sessions, users, voice-observability, observability-model, otel, traceai - Mermaid support: add Mermaid.astro, register it in vite-docs-transform, skip .mermaid in copy buttons, and add diagram-centering CSS in global.css - Nav: Observe > Concepts now points at /docs/observe/concepts/* Links to not-yet-migrated pages (traceai/*, observe/quickstart, observe/features/tags) are intentionally broken and land in later chunks.
4 tasks
… structure
Bring the Observe section in line with the revamp: the overview page (with its
trace-explorer image), the Quickstart, the Guides/Reference/Troubleshooting
pages, and the revamped Observe sidebar (Get started, Quickstart, Concepts,
Guides, Reference, Troubleshooting) in place of the old Features / Manual
Tracing / Integration layout.
- Add observe/index.mdx (overview) + llm-tracing-overview image, and
observe/quickstart.mdx
- Add observe/reference/{trace-filter-syntax,dashboard-metric-definitions,
export-formats}
- Add observe/troubleshooting/{no-traces-appearing,missing-attributes,
dashboard-numbers-look-wrong,alerts-did-not-fire}
- Repurpose observe/features/session as the "Explore sessions & users" guide
- Nav: replace the old Observe items with the revamped structure (kept the
group name 'Observability' so the product dropdown is unchanged); dropped the
never-created concepts/alerts and reference/span-types entries to avoid 404s
khushalsonawat
changed the title
…roject - Add five Guides pages (scaffolds) under observe/guides/: navigating through the dashboard, setup evals in observe, setup alerts for your project, using filters, saving a view - Add them to the Observe > Guides sidebar (kept Explore sessions & users) - Dashboard guide dogfoods the LLM Observability cookbook via a Note, pointing readers to the cookbook that exercises every Observe feature end to end - Rename the quickstart project to `self-improving-agent` (the running example we carry through the Observe docs) with a beginner-friendly request and matching expected output
…metry - Reference sidebar is now: Span types (subfolder), Filter syntax, Filter metrics, Span attributes, Project sampling rate, traceAI - Add a span-types/ subfolder: overview catalog plus one page per span kind (LLM, Tool, Retriever, Embedding, Reranker, Agent, Chain, Guardrail, Evaluator) - Add filter-metrics, span-attributes, and project-sampling-rate reference pages - Rename the traceAI SDK nav label to traceAI - Remove the OpenTelemetry concept page and repoint every link to the external OpenTelemetry site (https://opentelemetry.io/); drop it from the sidebar - Drop Dashboard metrics and Export and endpoints from the Reference sidebar (not in the new structure); the page files are kept but now unlinked
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What this is
First chunk of the Observe revamp, stacked on
docs/product-dropdown-order(parent PR #693). Replaces the oversized #681, which is closed in favour of landing the work in small, reviewable pieces.What's included (the Observe section as revamped)
observe/index.mdx) with the trace-explorer image, and Quickstart (observe/quickstart.mdx)observe/features/session)Observabilityso the product dropdown is unchangedMermaid.astro+ its registration, the skip-.mermaidguard inCodeCopyButtons.astro, and centering CSS inglobal.cssDeliberately out of scope (future chunks)
The traceAI SDK section, the
tracing//integrations/auto-instrumentation pages, the 148api/files,public/asset churn, and the straypr-assets/*.pdffrom #681 all stay out.Known broken links (intentional, land in later chunks)
The sidebar itself has no 404s. A few inline links in page bodies point at not-yet-migrated pages:
/docs/traceai/*(set-up-tracing, create-tool-spans, set-session-user-id, auto/livekit)/docs/observe/features/tagsTwo nav entries that never had pages even in #681 (
concepts/alerts,reference/span-types) were dropped to avoid 404s.Verification