Commit 8938eb7
authored
docs: replace Jaeger screenshot TODO with section scaffold (#105)
* docs: replace Jaeger screenshot TODO with section scaffold (#92)
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).
* chore: bump version to 0.2.111 parent 7c84f18 commit 8938eb7
3 files changed
Lines changed: 16 additions & 10 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
81 | 81 | | |
82 | 82 | | |
83 | 83 | | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
| 87 | + | |
84 | 88 | | |
85 | | - | |
| 89 | + | |
| 90 | + | |
| 91 | + | |
| 92 | + | |
| 93 | + | |
| 94 | + | |
| 95 | + | |
| 96 | + | |
86 | 97 | | |
87 | | - | |
88 | | - | |
89 | | - | |
90 | | - | |
91 | | - | |
| 98 | + | |
92 | 99 | | |
93 | | - | |
94 | | - | |
| 100 | + | |
95 | 101 | | |
96 | 102 | | |
97 | 103 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
3 | | - | |
| 3 | + | |
4 | 4 | | |
5 | 5 | | |
6 | 6 | | |
| |||
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
0 commit comments