Commit ee098fa
authored
docs(community): showcase two external Opik projects + allow external proof_url (#56)
## What & why
Showcases two external, community-built projects that use Opik, as
**listed** entries in `community/`:
- **[Building a Coding Agent from Scratch
(course)](https://github.com/decodingai-magazine/building-a-coding-agent-from-scratch-course)**
— Paul Iusztin / Decoding AI. Opik is used for tracing + evals (Lesson
7).
- **[Observable Job
Agent](https://github.com/jamwithai/observable-job-agent)** — Shirin
Khosravi Jam / jamwithai. Observability-first CV→job-matching agent
instrumented with Opik from run one.
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.py` — `validate_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
<!-- The main-repo example contract (run.sh / litellm / uv / dry-run)
does not apply to community entries — see community/CONTRIBUTING.md. -->
- [x] Change confined to `community/` (its lighter-weight contract, not
the root example contract)
- [x] Folder names are `lowercase_with_underscores` and pass
`community/_ci/check_entry.py`
- [x] Both entries have all four required README sections and a valid
`meta.yaml`; `author` is the owning GitHub org so `github.com/<author>`
resolves
- [x] Proof of Opik usage present (real external `proof_url` for each)
- [x] `community/README.md` regenerated via `build_index.py` (`--check`
clean)
- [x] `python -m pytest -q` in `community/_ci` — 51 passing
- [x] No credentials or `.env` files committed
🤖 Generated with [Claude Code](https://claude.com/claude-code)9 files changed
Lines changed: 163 additions & 15 deletions
File tree
- community
- _ci
- tests
- jamwithai_observable_job_agent
- paul_iusztin_coding_agent_course
- templates/entry-template
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
8 | 8 | | |
9 | 9 | | |
10 | 10 | | |
11 | | - | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
12 | 15 | | |
13 | 16 | | |
14 | 17 | | |
| |||
42 | 45 | | |
43 | 46 | | |
44 | 47 | | |
45 | | - | |
| 48 | + | |
| 49 | + | |
46 | 50 | | |
47 | 51 | | |
48 | 52 | | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
9 | 9 | | |
10 | 10 | | |
11 | 11 | | |
12 | | - | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
107 | 107 | | |
108 | 108 | | |
109 | 109 | | |
110 | | - | |
111 | | - | |
112 | | - | |
113 | | - | |
114 | 110 | | |
115 | | - | |
116 | | - | |
117 | | - | |
118 | | - | |
| 111 | + | |
| 112 | + | |
| 113 | + | |
| 114 | + | |
| 115 | + | |
| 116 | + | |
| 117 | + | |
| 118 | + | |
| 119 | + | |
| 120 | + | |
| 121 | + | |
| 122 | + | |
| 123 | + | |
| 124 | + | |
| 125 | + | |
| 126 | + | |
| 127 | + | |
| 128 | + | |
| 129 | + | |
| 130 | + | |
119 | 131 | | |
120 | 132 | | |
121 | 133 | | |
| |||
132 | 144 | | |
133 | 145 | | |
134 | 146 | | |
135 | | - | |
136 | | - | |
| 147 | + | |
| 148 | + | |
| 149 | + | |
| 150 | + | |
137 | 151 | | |
138 | 152 | | |
139 | 153 | | |
| |||
180 | 194 | | |
181 | 195 | | |
182 | 196 | | |
183 | | - | |
184 | | - | |
| 197 | + | |
| 198 | + | |
| 199 | + | |
| 200 | + | |
185 | 201 | | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
212 | 212 | | |
213 | 213 | | |
214 | 214 | | |
| 215 | + | |
| 216 | + | |
| 217 | + | |
| 218 | + | |
| 219 | + | |
| 220 | + | |
| 221 | + | |
| 222 | + | |
| 223 | + | |
| 224 | + | |
| 225 | + | |
| 226 | + | |
| 227 | + | |
| 228 | + | |
| 229 | + | |
| 230 | + | |
| 231 | + | |
| 232 | + | |
| 233 | + | |
| 234 | + | |
| 235 | + | |
| 236 | + | |
| 237 | + | |
| 238 | + | |
| 239 | + | |
| 240 | + | |
| 241 | + | |
| 242 | + | |
| 243 | + | |
| 244 | + | |
| 245 | + | |
| 246 | + | |
| 247 | + | |
| 248 | + | |
| 249 | + | |
| 250 | + | |
| 251 | + | |
| 252 | + | |
| 253 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
5 | 5 | | |
6 | 6 | | |
7 | 7 | | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
8 | 13 | | |
9 | 14 | | |
10 | 15 | | |
0 commit comments