Complete the dataset card: layout, versions, manifest schema, consuming (FLIP#1236, PR #1238)
Browse files
README.md
CHANGED
|
@@ -33,3 +33,53 @@ FLIP UI against a mocked backend (`flip-ui/test/cypress/docs/`), converted with
|
|
| 33 |
|
| 34 |
One copy of every file, at an unversioned path:
|
| 35 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 33 |
|
| 34 |
One copy of every file, at an unversioned path:
|
| 35 |
|
| 36 |
+
| Path | Contents |
|
| 37 |
+
| --- | --- |
|
| 38 |
+
| `admin/<name>.gif` | one per `flip-ui/test/cypress/docs/admin/<name>.spec.ts` |
|
| 39 |
+
| `flip/<name>.gif` | one per `flip-ui/test/cypress/docs/flip/<name>.spec.ts` |
|
| 40 |
+
| `manifest.json` | the provenance of this version and the sha256 + size of every GIF |
|
| 41 |
+
| `README.md` | this card (`docs/scripts/docs_gifs_card.md` in the FLIP repository) |
|
| 42 |
+
|
| 43 |
+
## Versions
|
| 44 |
+
|
| 45 |
+
A version is a git **tag** on this dataset, named `YYYYMMDDTHHMMSSZ-<sha7>`: the UTC instant the recording
|
| 46 |
+
started and the first seven characters of the FLIP `develop` commit the GIFs were recorded from. Every publish
|
| 47 |
+
is one commit on `main` (the GIF of every demo spec, deletions for GIFs whose spec is gone, the manifest and
|
| 48 |
+
this card) followed by one tag on that commit. The FLIP docs pin a tag in `docs/.gifs_version` and fetch it at
|
| 49 |
+
build time, so:
|
| 50 |
+
|
| 51 |
+
- **Tags are never moved** — the publisher refuses a tag that already exists rather than re-pointing it.
|
| 52 |
+
- **Tags are never deleted** — historical documentation builds keep resolving their pin.
|
| 53 |
+
- `main` is a moving ref: consumers pin a tag, never `main`.
|
| 54 |
+
|
| 55 |
+
## Manifest
|
| 56 |
+
|
| 57 |
+
`manifest.json` is canonical JSON (sorted keys, two-space indent, trailing newline):
|
| 58 |
+
|
| 59 |
+
```json
|
| 60 |
+
{
|
| 61 |
+
"version": "20260907T122006Z-5945242",
|
| 62 |
+
"source_commit": "<the 40-hex FLIP develop commit the GIFs were recorded from>",
|
| 63 |
+
"recorded_at": "2026-09-07T12:20:06Z",
|
| 64 |
+
"workflow_run": "https://github.com/londonaicentre/FLIP/actions/runs/<id>",
|
| 65 |
+
"files": {
|
| 66 |
+
"admin/create-user.gif": { "sha256": "<64 hex>", "bytes": 1234567 },
|
| 67 |
+
"flip/create-project.gif": { "sha256": "<64 hex>", "bytes": 2345678 }
|
| 68 |
+
}
|
| 69 |
+
}
|
| 70 |
+
```
|
| 71 |
+
|
| 72 |
+
`version` is the tag; `recorded_at` is the tag's timestamp; `workflow_run` is `null` for a hand publish. A
|
| 73 |
+
consumer verifies both `sha256` and `bytes` of every file before using it, and treats the manifest as the
|
| 74 |
+
complete list of files at that version.
|
| 75 |
+
|
| 76 |
+
## Consuming
|
| 77 |
+
|
| 78 |
+
Everything is public and read anonymously:
|
| 79 |
+
|
| 80 |
+
```text
|
| 81 |
+
https://huggingface.co/datasets/aicentreflip/docs-gifs/resolve/<tag>/manifest.json
|
| 82 |
+
https://huggingface.co/datasets/aicentreflip/docs-gifs/resolve/<tag>/<category>/<name>.gif
|
| 83 |
+
```
|
| 84 |
+
|
| 85 |
+
The FLIP docs build does exactly this (`docs/scripts/fetch_docs_gifs.py`, run from `docs/source/conf.py`).
|