From 3dbd9a1a4c40eb448824b62692775fc53c8ddfa2 Mon Sep 17 00:00:00 2001 From: Gramps Date: Tue, 5 Aug 2025 22:03:29 -0700 Subject: [PATCH] Updated Metadata Format (markdown) --- Metadata Format.md | 3 --- Metadata-Format.md | 51 ++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 51 insertions(+), 3 deletions(-) delete mode 100644 Metadata Format.md create mode 100644 Metadata-Format.md diff --git a/Metadata Format.md b/Metadata Format.md deleted file mode 100644 index 1269f35..0000000 --- a/Metadata Format.md +++ /dev/null @@ -1,3 +0,0 @@ -# Metadata Format - -_TODO: Add content here._ \ No newline at end of file diff --git a/Metadata-Format.md b/Metadata-Format.md new file mode 100644 index 0000000..448847b --- /dev/null +++ b/Metadata-Format.md @@ -0,0 +1,51 @@ +## ๐Ÿ“„ Metadata Format + +This page documents the schema and structural expectations of `notes.json` files used by the LCS Pipeline. + +--- + +### ๐Ÿ“ File Name Convention + +Each `notes.json` file must be: +- Named: `.notes.json` +- Stored in the same folder as its clip + +--- + +### ๐Ÿงฑ Field Definitions + +| Field | Type | Required | Description | +|-------------|-----------|----------|-------------| +| `highlight` | `string` | โœ… Yes | A short, engaging summary of the moment | +| `tags` | `array` | โŒ No | List of hashtags/keywords | +| `gag_name` | `string` | โŒ No | Optional meme-style or alt title | + +--- + +### ๐Ÿง  Notes + +- `highlight` must be under ~100 characters (for overlays + social) +- `tags` will be used to generate hashtags and platform metadata +- `gag_name` is used for meme variants, overlays, or alt titling + +--- + +### ๐Ÿ”„ Evolution + +This format is designed to evolve. Fields like `tone`, `voice_note`, and `priority` were considered and deliberately excluded for simplicity. + +--- + +### ๐Ÿงช Example + +```json +{ + "highlight": "Double knock with a single pump shot ๐Ÿ˜ฑ", + "tags": ["Pump", "Knockout", "Fortnite"], + "gag_name": "Old Man Boomstick" +} +``` + +--- + +Next page: [`Metadata History`](./Metadata-History)