Add source callout to example walk-through docs#122
Merged
Conversation
Inserts a Material ``!!! info "Source"`` admonition between the
H1 and the lead paragraph on every example walk-through doc. The
admonition links the page's main.py on the LunarCommand GitHub
repo (``/blob/main/examples/<name>/main.py``), opening in a new
tab via ``{target="_blank" rel="noopener"}``.
Applied to all 13 walk-throughs (one callout each):
chat-with-multimodal, checkpointing-and-migration,
explicit-subgraph-mapping, fan-out-with-retry, hello-world,
langfuse-observability, multimodal-prompt, nested-subgraphs,
observer-hooks, parallel-branches, production-observability,
routing-and-subgraphs, tool-use.
Styling: overrides the default Material info-admonition accent
to the project lavender (rgb(228, 193, 249)); inside the
admonition, slate-theme link color shifts to the body-text gray
(rgba(226, 228, 233, 0.82)) so the URL reads as content rather
than as a highlighted action against the lavender backdrop.
URLs use the LunarCommand org for now; will need a one-line perl
substitution after the OpenArmature org move per the
project_org_move_to_openarmature memory.
There was a problem hiding this comment.
Pull request overview
Adds a consistent “Source” callout to each example walk-through doc, linking directly to the corresponding examples/<name>/main.py on GitHub, and introduces scoped styling so the callout matches the site’s slate-theme visual language.
Changes:
- Inserted a
!!! info "Source"admonition between the H1 and lead paragraph across 13 example walk-through pages, linking to the example’smain.py(opens in a new tab withrel="noopener"). - Added CSS overrides to restyle Material’s
infoadmonition accent to the project lavender, plus a slate-theme link color adjustment within that admonition.
Reviewed changes
Copilot reviewed 14 out of 14 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| docs/stylesheets/extra.css | Adds styling overrides for the Source callout (info admonition) and link color within it (slate scheme). |
| docs/examples/chat-with-multimodal.md | Adds “Source” admonition linking to examples/chat-with-multimodal/main.py. |
| docs/examples/checkpointing-and-migration.md | Adds “Source” admonition linking to examples/checkpointing-and-migration/main.py. |
| docs/examples/explicit-subgraph-mapping.md | Adds “Source” admonition linking to examples/explicit-subgraph-mapping/main.py. |
| docs/examples/fan-out-with-retry.md | Adds “Source” admonition linking to examples/fan-out-with-retry/main.py. |
| docs/examples/hello-world.md | Adds “Source” admonition linking to examples/hello-world/main.py. |
| docs/examples/langfuse-observability.md | Adds “Source” admonition linking to examples/langfuse-observability/main.py. |
| docs/examples/multimodal-prompt.md | Adds “Source” admonition linking to examples/multimodal-prompt/main.py. |
| docs/examples/nested-subgraphs.md | Adds “Source” admonition linking to examples/nested-subgraphs/main.py. |
| docs/examples/observer-hooks.md | Adds “Source” admonition linking to examples/observer-hooks/main.py. |
| docs/examples/parallel-branches.md | Adds “Source” admonition linking to examples/parallel-branches/main.py. |
| docs/examples/production-observability.md | Adds “Source” admonition linking to examples/production-observability/main.py. |
| docs/examples/routing-and-subgraphs.md | Adds “Source” admonition linking to examples/routing-and-subgraphs/main.py. |
| docs/examples/tool-use.md | Adds “Source” admonition linking to examples/tool-use/main.py. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
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.
Summary
Inserts a Material
!!! info "Source"admonition between the H1 and the lead paragraph on every example walk-through doc. The admonition links the page'smain.pyon GitHub (/blob/main/examples/<name>/main.py), opening in a new tab via{target="_blank" rel="noopener"}.Applied uniformly to all 13 walk-throughs (one callout each): chat-with-multimodal, checkpointing-and-migration, explicit-subgraph-mapping, fan-out-with-retry, hello-world, langfuse-observability, multimodal-prompt, nested-subgraphs, observer-hooks, parallel-branches, production-observability, routing-and-subgraphs, tool-use.
Styling
info-admonition accent to the project lavenderrgb(228, 193, 249)(matching the inline-code color used elsewhere in the slate theme).rgba(226, 228, 233, 0.82)so the URL reads as content rather than as a highlighted action against the lavender backdrop.Currently
!!! infois used only for these Source callouts site-wide, so the styling effectively scopes to "the Source box". If a future doc adds a non-Source info admonition that should stay default-blue, the convention can flip to a custom!!! sourcetype and the CSS re-scope to.admonition.source. Comment inextra.cssnotes this.URLs
Uses the LunarCommand org for now per the
project_org_move_to_openarmaturememory; will need a one-line perl substitution after the OpenArmature org move.Test plan
uv run mkdocs build --strictcleanmain.py