Skip to content

docs(observe): Traces, Spans, Quickstart pages + Release notes nav#698

Merged
khushalsonawat merged 3 commits into
devfrom
docs/observe-concept-pages
Jul 1, 2026
Merged

docs(observe): Traces, Spans, Quickstart pages + Release notes nav#698
khushalsonawat merged 3 commits into
devfrom
docs/observe-concept-pages

Conversation

@khushalsonawat

Copy link
Copy Markdown
Contributor

What

Ships the four completed Observe pages to dev, scoped to only the relevant changes (no nav restructure):

  • New pages: Traces, Spans (concepts), Quickstart
  • Updated: Observe Get started overview (lightened)
  • Nav: repointed the existing Observe Traces / Spans / Set Up Observability entries to the new pages, and added a Release notes section under Get Started

Why these aren't a clean cherry-pick

The pages were authored for the new IA (a traceai tab, observe/concepts, observe/reference, observe/troubleshooting) that isn't on dev yet. To avoid shipping dead links, every internal link was repointed to dev's current paths:

New-IA link Repointed to
observe/concepts/otel tracing/concepts/otel
observe/concepts/traceai tracing/concepts/traceai
observe/concepts/sessions-and-users observe/features/session
traceai/manual-instrumentation/set-up-tracing observe/features/manual-tracing/set-up-tracing
traceai/manual-instrumentation/create-tool-spans observe/features/manual-tracing/create-tool-spans
traceai/auto tracing/auto

Three links with no dev equivalent were dropped: observability-model, reference/span-types, troubleshooting/no-traces-appearing. All remaining internal links resolve on dev.

Supporting fixes (needed for the pages to render)

  • Register the Mermaid MDX component in vite-docs-transform (dev had no entry, so <Mermaid> wouldn't import)
  • Move the Steps step-chain CSS and Mermaid SVG centering into global.css so they survive client-side (FastNav) navigation rather than being dropped with page-scoped <style> tags
  • Stop the global copy-button from injecting into Mermaid diagrams (it polluted the parser on client-side nav)

Verified

  • All 5 routes compile (200) and Mermaid renders cleanly
  • Every internal link resolves on dev
  • Sidebar entries repointed; Release notes shows as its own section

🤖 Generated with Claude Code

Add the revamped Observe concept pages (Traces, Spans), the new Quickstart, and
a lightened Get started overview, with all internal links repointed to dev's
current IA so nothing 404s.

Supporting fixes so the pages render correctly:
- Register the Mermaid MDX component (vite-docs-transform COMPONENT_MAP)
- Move the Steps step-chain CSS and the Mermaid SVG centering into global.css
  so they survive client-side (FastNav) navigation instead of being dropped
  with page-scoped <style> tags
- Stop the global copy-button from injecting into Mermaid diagrams (it broke
  the parser on client-side nav)

Nav: repoint the Observe Traces/Spans/Quickstart entries to the new pages and
add a Release notes section under Get Started.
@khushalsonawat khushalsonawat self-assigned this Jun 30, 2026
The Quickstart 'Confirm the trace' step references
/images/docs/observe/llm-tracing-overview.webp, which was absent from the repo
source (only present as a stale dist/ build artifact). Restore it so the image
renders.
@khushalsonawat khushalsonawat merged commit 244fa26 into dev Jul 1, 2026
4 checks passed
@khushalsonawat khushalsonawat deleted the docs/observe-concept-pages branch July 1, 2026 06:38
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.

2 participants