docs: replace Jaeger screenshot TODO with section scaffold#105
Merged
Conversation
This was referenced May 25, 2026
constk
added a commit
that referenced
this pull request
May 26, 2026
…sed post-#103/#104) main moved ahead of develop on 2026-05-25 when PR #86 was merged directly to main rather than via develop -> release flow. The divergence is one squash commit (eff5b1c) carrying: - docs/BEADS.md (optional Beads issue-queue guidance) - .github/pull_request_template.md (Beads PR-template block) - .github/scripts/check_aspirational_tickets.py (PEP 758 reformat) - .github/scripts/check_pin_freshness.py / check_tests_present.py / check_version_bump.py (touch-ups) - .gitattributes / .gitignore (.beads/ ignore, Windows renormalise) - CONTRIBUTING.md (line-ending normalisation) - tests/test_scripts_compile.py (new CI-script compile gate) - docs/DEVELOPMENT.md / docs/HARNESS.md / docs/HARNESS_PRIMER.md cross-refs - pyproject.toml + uv.lock self-version 0.2.10 -> 0.2.11 This PR was rebased after #103 (CVE fix, develop -> 0.2.11) and #104 (eval pattern examples, develop -> 0.2.12) merged. The version on main (0.2.11) is now behind develop (0.2.12); the conflict is resolved by bumping develop -> 0.2.13. After this lands, develop is at 0.2.13 and contains everything main has. Remaining in-flight PRs (#99, #100, #101, #105) need to rebase to bump 0.2.13 -> 0.2.14 (and onward sequentially as they merge). No behaviour change beyond what #86 already added to main. # Conflicts: # pyproject.toml # uv.lock
The observability story in README has one visible loose end: a TODO
block where the Jaeger trace screenshot should go. The rest of the
section reads cleanly, so the TODO sticks out.
Promotes the placeholder to a real subsection ("Jaeger trace") with
the explanatory caption already written: what boots the stack, what
endpoint produces the trace, where to view it, and that span
attributes use only the constant-defined semconv keys from
src/observability/spans.py.
The image itself still needs to be captured. The original capture
recipe is preserved as an HTML comment so it remains discoverable,
and the comment includes the exact one-line markdown to paste in once
docs/images/jaeger-trace.png lands. Hiding the placeholder inside an
HTML comment (rather than a broken-image ref) keeps the rendered
README clean while the PNG is outstanding.
The image-capture step itself is a follow-up — needs the maintainer
to run docker compose locally and take the screenshot.
Closes #92 (capture step tracked separately as a single-line README
edit when the PNG is committed).
constk
force-pushed
the
docs/92-jaeger-trace-scaffold
branch
from
f9ba881 to
02bd1aa
Compare
This was referenced May 26, 2026
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 & why
The observability section of README.md had a TODO block where the Jaeger trace screenshot should go. This PR promotes the placeholder to a real subsection — heading, caption, link to src/observability/spans.py — so the section reads cleanly today even while the screenshot is outstanding.
The PNG itself still needs to be captured. The original capture recipe is preserved inside an HTML comment, alongside the exact one-line markdown to paste when
docs/images/jaeger-trace.pngis committed. Hiding the placeholder inside an HTML comment rather than a broken-image reference keeps the rendered README clean in the meantime.Closes #92.
Test plan
Invariants affected
None.
New deps / actions / external surface
None.
Linked issue
Closes #92