Skip to content

docs(community): showcase two external Opik projects + allow external proof_url - #56

Merged
LeoRoccoBreedt merged 7 commits into
mainfrom
LeoRoccoBreedt/community-showcase-entries
Jul 29, 2026
Merged

docs(community): showcase two external Opik projects + allow external proof_url#56
LeoRoccoBreedt merged 7 commits into
mainfrom
LeoRoccoBreedt/community-showcase-entries

Conversation

@LeoRoccoBreedt

Copy link
Copy Markdown
Collaborator

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_url in meta.yaml (pointing at the author's own trace screenshot / setup doc) as an alternative to a committed opik-proof.png. The committed-PNG path is unchanged for normal author submissions.

Changes

  • community/_ci/entry_rules.pyvalidate_proof accepts a committed+referenced opik-proof.png or an http(s):// proof_url; signature unchanged, PNG path behavior preserved.
  • community/_ci/tests/test_entry_rules.py — new tests for the proof_url accept 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 optional proof_url.
  • Two new listed entries (paul_iusztin_coding_agent_course/, jamwithai_observable_job_agent/), each meta.yaml + README.md.
  • community/README.md — regenerated by build_index.py (two-row index).

Each proof_url points 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

  • Change confined to community/ (its lighter-weight contract, not the root example contract)
  • Folder names are lowercase_with_underscores and pass community/_ci/check_entry.py
  • Both entries have all four required README sections and a valid meta.yaml; author is the owning GitHub org so github.com/<author> resolves
  • Proof of Opik usage present (real external proof_url for each)
  • community/README.md regenerated via build_index.py (--check clean)
  • python -m pytest -q in community/_ci — 51 passing
  • No credentials or .env files committed

🤖 Generated with Claude Code

LeoRoccoBreedt and others added 7 commits July 24, 2026 09:54
…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>
@LeoRoccoBreedt
LeoRoccoBreedt merged commit ee098fa into main Jul 29, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant