Skip to content

Commit 71a05bc

Browse files
Style concept callouts as brand-lavender info boxes
Both in-page callouts in docs/concepts/observability.md (the new proposal-0054 bundling note and the pre-existing Langfuse SDK version compatibility note) were using `!!! note`, which renders in Material's default blue. The 13 example walk-through pages use `!!! info "Source"`, which the project CSS paints in the brand lavender. Flip the two concept-page callouts to `!!! info` so every admonition site-wide picks up the same brand styling. Also refresh the now-stale CSS comment that claimed the only `!!! info` usage was the Source box.
1 parent c31405f commit 71a05bc

2 files changed

Lines changed: 15 additions & 14 deletions

File tree

docs/concepts/observability.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -581,7 +581,7 @@ async def persist(state: PipelineState) -> Mapping[str, Any]:
581581
`graph.drain()` but scoped to one invocation. Returns the same
582582
`DrainSummary` shape, with the same timeout discipline.
583583

584-
!!! note "drain_events_for ships in v0.12.0 alongside the read API"
584+
!!! info "drain_events_for ships in v0.12.0 alongside the read API"
585585
`CompiledGraph.drain_events_for` is the spec §6 / proposal 0054
586586
pair to the §9.4 accumulator lifecycle described above. The two
587587
proposals are bundled into the v0.12.0 release cycle as
@@ -933,7 +933,7 @@ same in tests and production. See
933933
[`examples/langfuse-observability`](../examples/langfuse-observability.md)
934934
for a runnable demo.
935935

936-
!!! note "Langfuse SDK version compatibility"
936+
!!! info "Langfuse SDK version compatibility"
937937

938938
Validated against `langfuse>=4.6,<5`. The v4 SDK introduced an
939939
OTel-based architecture with `start_observation` /

docs/stylesheets/extra.css

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -285,18 +285,19 @@
285285
padding-left: 0.75rem;
286286
}
287287

288-
/* Source-box callout color (the ``!!! info "Source"`` admonition
289-
* inserted between the H1 and lead paragraph on every example
290-
* walk-through doc). Material's default ``info`` admonition uses
291-
* a blue accent; this override paints it in the project lavender
292-
* to match the ``#9d4edd`` brand purple and inline-code color
293-
* (``#e4c1f9`` ≈ rgb(228, 193, 249)) used elsewhere in the slate
294-
* theme. Scoped to ``.admonition.info``; currently the only
295-
* ``!!! info`` usage in the docs is the Source callout, so this
296-
* effectively styles "the Source box". If a future doc adds a
297-
* non-Source info admonition that should stay blue, switch the
298-
* walk-through callouts to a custom ``!!! source`` type and
299-
* re-scope this rule to ``.admonition.source``. */
288+
/* Brand-lavender callout color, applied to every ``!!! info``
289+
* admonition site-wide. Material's default ``info`` admonition
290+
* uses a blue accent; this override paints it in the project
291+
* lavender to match the ``#9d4edd`` brand purple and inline-code
292+
* color (``#e4c1f9`` ≈ rgb(228, 193, 249)) used elsewhere in the
293+
* slate theme. Two usage shapes in the docs today:
294+
* - the ``!!! info "Source"`` box inserted between the H1 and
295+
* lead paragraph on every example walk-through page; and
296+
* - in-page concept callouts (e.g. the proposal-0054 bundling
297+
* note in ``concepts/observability.md``).
298+
* If a future doc needs a generic info admonition that stays in
299+
* Material's default blue, switch this rule to a custom
300+
* ``!!! brand`` admonition type and migrate the existing call sites. */
300301
.md-typeset .admonition.info,
301302
.md-typeset details.info {
302303
border-color: rgb(228, 193, 249);

0 commit comments

Comments
 (0)