Skip to content

docs(observe): Observability model concept revamp#703

Merged
khushalsonawat merged 1 commit into
docs/observe-conceptsfrom
docs/observe-observability-model
Jul 2, 2026
Merged

docs(observe): Observability model concept revamp#703
khushalsonawat merged 1 commit into
docs/observe-conceptsfrom
docs/observe-observability-model

Conversation

@YashMohan23

@YashMohan23 YashMohan23 commented Jul 1, 2026

Copy link
Copy Markdown

What this is

Revamps the Observability model concept page (the synthesis page for Observe) for full compliance with the docs review checklist and one-read clarity.

Changes

  • Frontmatter stripped to title + description; all 22 em-dashes removed.
  • ## About → descriptive ## A few objects that nest; footer Next stepsKeep exploring.
  • One Mermaid (removed the pipeline diagram); removed the inline using_session code (setup is a how-to → linked to the manual-tracing guides).
  • Sibling concepts linked on first mention (were bolded); fixed a dead manual-tracing link; forward-only cards with valid Card.astro icons.
  • Shape-first opener so the span → trace → session → user hierarchy lands in one read; each object defined once (in Key terms), not twice.

Checklist

Concept (Explanation) page: minimal frontmatter, no "About", one Diátaxis mode, one Mermaid, forward "Keep exploring" cards, no em-dashes, all links + icons valid, grounded in code.

Diátaxis: Explanation · depth 4 · ease medium.

…base)

Rebased onto docs/observe-concepts, which had externalized OpenTelemetry.
Adopt the same change: OTel links now point to https://opentelemetry.io/.
Full revamp otherwise unchanged (compliance + one-read clarity).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@YashMohan23 YashMohan23 force-pushed the docs/observe-observability-model branch from 92ea457 to 874bda0 Compare July 1, 2026 13:48
@khushalsonawat khushalsonawat merged commit bfa0b4c into docs/observe-concepts Jul 2, 2026
1 check passed
@khushalsonawat khushalsonawat deleted the docs/observe-observability-model branch July 2, 2026 12:09
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