Skip to content

Commit 5db7191

Browse files
committed
docs: drop model-snapshot from roadmap; link harness from root README
1 parent 15f9943 commit 5db7191

2 files changed

Lines changed: 3 additions & 5 deletions

File tree

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ Evaluators and the supporting datasets are built in collaboration with leading l
2828
| :------------------------ | :--------------------------------------------------------------- |
2929
| [`evals`](./evals/) | Evaluators code and prompts |
3030
| [`datasets`](./datasets/) | Expert annotated datasets used to create and validate evaluators |
31+
| [`scripts`](./scripts/) | Repo check harness — run `python scripts/check.py --fix` before committing (see [scripts/README](./scripts/README.md)) |
3132
| [`LICENSE`](./LICENSE.md) | Open source license details |
3233

3334
Check out the [Evaluators docs](https://docs.learningcommons.org/evaluators) for complete setup instructions and usage examples.

scripts/README.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -45,15 +45,12 @@ fails the PR (it never auto-fixes) — so fixing locally saves a round-trip.
4545

4646
This is the seed of a broader self-service harness. Planned additions:
4747

48-
- **model-snapshot pinning** — require `model.name` to reference a pinned
49-
snapshot (provider-specific), so evaluators don't float across model updates.
5048
- **delegation to the SDK suites** (`sdks/typescript` lint/type/test,
5149
`sdks/python` Makefile) so one local command covers everything. CI keeps the
5250
per-SDK workflows separate for parallelism and path-filtered signal.
5351

54-
> **TODO** (once there are more checks): surface this from the root `README.md`
55-
> / `CONTRIBUTING.md` so newcomers discover it — e.g. "Before committing, run
56-
> `python scripts/check.py --fix` (see `scripts/README.md`)."
52+
> **TODO**: the root `README.md` links here for discoverability; give this a
53+
> proper home in a `CONTRIBUTING.md` once one exists.
5754
5855
## Adding a check
5956

0 commit comments

Comments
 (0)