Updated Metadata Format (markdown)

Gramps
2025-08-05 22:03:29 -07:00
parent e57e5b82fa
commit 3dbd9a1a4c
2 changed files with 51 additions and 3 deletions

@ -1,3 +0,0 @@
# Metadata Format
_TODO: Add content here._

51
Metadata-Format.md Normal file

@ -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: `<clipname>.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)