docs: replace Jaeger screenshot TODO with section scaffold#102
Closed
constk wants to merge 7 commits into
Closed
Conversation
release: bring main up to develop (every harness ticket)
release: sync main with develop (Vite proxy fix + README screenshots)
release: bring main up to develop (Teller v1.4 → v1.10.3 backport)
release: bring main up to develop (Teller v1.12.0 backports + audit follow-up)
…t compile gate) Applies the actionable items from the PR-86 review: - docs/BEADS.md: lead with a one-sentence "what Beads is" + upstream link; state the stance explicitly (optional/additive, recommended for agent-driven flows, GitHub remains authoritative); add a YAML example block under Recommended Bead fields; replace the duplicated Closure checklist with a Bead-specific narrowing that cites the PR template + CONTRIBUTING; call out that .beads/ is wiped by git clean -fdx. - .github/pull_request_template.md: collapse the "Local Beads" section into an HTML-commented opt-in block so it is invisible in the rendered preview until a Beads-using team uncomments it. - CONTRIBUTING.md: document the one-shot git renormalisation step for Windows clones after the .gitattributes change lands. - tests/test_scripts_compile.py: regression gate that py_compiles every .github/scripts/*.py. The "scripts unparseable" review finding was based on an older local Python — PEP 758 (3.14) makes the unparenthesised except clauses valid, so the scripts ARE fine on the project pin. The test guards against an actual syntax error landing in future.
5 tasks
3 tasks
constk
added a commit
that referenced
this pull request
May 26, 2026
pip-audit on develop is flagging two transitive-dep CVEs: - idna 3.13 CVE-2026-45409 (fix in 3.15+) - starlette 1.0.0 PYSEC-2026-161 (fix in 1.0.1+) Both are surfaced via fastapi/httpx. Bumps via: uv lock --upgrade-package idna --upgrade-package starlette Resolves to idna 3.16 (3.15 was the listed fix; 3.16 is a further patch with the same fix) and starlette 1.1.0 (minor bump; FastAPI is compatible with it). All 192 unit tests pass on the upgraded lock. Bumps the project self-version 0.2.10 -> 0.2.11 per docs/DEVELOPMENT.md. Unblocks the pip-audit CI gate on #99, #100, #101, #102 (and any other PRs currently sitting on develop), all of which inherit the flagged transitive CVEs from develop and cannot pass that gate until this lands.
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
2 participants
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 (lines 83–94 before this change) 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 — references the existing semconv-keys-only constraint (already enforced via
src/observability/spans.pyconstants) but adds no new rule.New deps / actions / external surface
None.
Linked issue
Closes #92