docs(community): showcase two external Opik projects + allow external proof_url - #56
Merged
Merged
Conversation
…ISC004 CI's ruff (resolved from ruff>=0.6) flags ISC004 on implicitly concatenated f-strings inside return[...] collections. Wrap each pair in parentheses so they form a single string. Behavior-preserving; also covers two pre-existing sites now caught by the newer ruff. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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.
What & why
Showcases two external, community-built projects that use Opik, as listed entries in
community/:Both link out to the authors' own repos (
hosted: false); no external code is vendored in.Since these are maintainer-added showcases (not author self-submissions), we don't hold the authors' Opik screenshots. So this PR also relaxes the community proof rule: an entry can now prove Opik usage with an http(s)
proof_urlinmeta.yaml(pointing at the author's own trace screenshot / setup doc) as an alternative to a committedopik-proof.png. The committed-PNG path is unchanged for normal author submissions.Changes
community/_ci/entry_rules.py—validate_proofaccepts a committed+referencedopik-proof.pngor an http(s)://proof_url; signature unchanged, PNG path behavior preserved.community/_ci/tests/test_entry_rules.py— new tests for theproof_urlaccept path, the non-http reject, the scheme-less (httpfoo) reject, and no-proof reject. Suite: 51 passing.community/templates/entry-template/meta.yaml+community/CONTRIBUTING.md— document the optionalproof_url.paul_iusztin_coding_agent_course/,jamwithai_observable_job_agent/), eachmeta.yaml+README.md.community/README.md— regenerated bybuild_index.py(two-row index).Each
proof_urlpoints at a real, public page in the author's repo showing Opik usage (a traces screenshot and an Opik setup/tracing doc, respectively) — no fabricated proof.Checklist
community/(its lighter-weight contract, not the root example contract)lowercase_with_underscoresand passcommunity/_ci/check_entry.pymeta.yaml;authoris the owning GitHub org sogithub.com/<author>resolvesproof_urlfor each)community/README.mdregenerated viabuild_index.py(--checkclean)python -m pytest -qincommunity/_ci— 51 passing.envfiles committed🤖 Generated with Claude Code