From e56061ecbcf58907a3d4452fdab2eb2f93b11f1d Mon Sep 17 00:00:00 2001 From: Jeroen Schweitzer Date: Sat, 14 Mar 2026 00:15:51 +0100 Subject: [PATCH] docs(docs): add frontmatter to asset pipeline docs Standardized YAML frontmatter on all 13 docs/assets/ files covering audio, visual, and video pipeline docs, palettes, and templates. Co-Authored-By: Claude Opus 4.6 --- docs/assets/README.md | 7 +++++++ docs/assets/_templates/audio.md | 7 +++++++ docs/assets/_templates/sprite.md | 7 +++++++ docs/assets/_templates/video.md | 7 +++++++ docs/assets/audio/README.md | 7 +++++++ docs/assets/audio/ambient.md | 7 +++++++ docs/assets/audio/palette.md | 7 +++++++ docs/assets/audio/sfx.md | 7 +++++++ docs/assets/audio/ui.md | 7 +++++++ docs/assets/video/README.md | 7 +++++++ docs/assets/video/palette.md | 7 +++++++ docs/assets/visual/README.md | 7 +++++++ docs/assets/visual/palette.md | 7 +++++++ 13 files changed, 91 insertions(+) diff --git a/docs/assets/README.md b/docs/assets/README.md index dcca40e1c..d808c1ca7 100644 --- a/docs/assets/README.md +++ b/docs/assets/README.md @@ -1,3 +1,10 @@ +--- +title: "Asset Pipeline Index" +description: "Master index linking all asset pipelines (audio, visual, video) with structure and conventions" +type: design +status: active +--- + # Asset Pipeline Index Centralized tracking for all production assets across pipelines. Each pipeline has its own index, palette (style bible), and per-category asset tables. diff --git a/docs/assets/_templates/audio.md b/docs/assets/_templates/audio.md index 5ceadd180..50e925d20 100644 --- a/docs/assets/_templates/audio.md +++ b/docs/assets/_templates/audio.md @@ -1,3 +1,10 @@ +--- +title: "Audio Asset Template" +description: "Row and detailed entry templates for audio asset documentation" +type: design +status: active +--- + # Audio Asset Template ## Table Row Format diff --git a/docs/assets/_templates/sprite.md b/docs/assets/_templates/sprite.md index dec19e3a1..52dd0bef9 100644 --- a/docs/assets/_templates/sprite.md +++ b/docs/assets/_templates/sprite.md @@ -1,3 +1,10 @@ +--- +title: "Sprite Asset Template" +description: "Row and detailed entry templates for sprite and visual asset documentation" +type: design +status: active +--- + # Sprite Asset Template ## Table Row Format diff --git a/docs/assets/_templates/video.md b/docs/assets/_templates/video.md index d56e672b7..031941ced 100644 --- a/docs/assets/_templates/video.md +++ b/docs/assets/_templates/video.md @@ -1,3 +1,10 @@ +--- +title: "Video Asset Template" +description: "Row and detailed entry templates for video asset documentation" +type: design +status: active +--- + # Video Asset Template ## Table Row Format diff --git a/docs/assets/audio/README.md b/docs/assets/audio/README.md index 99f6d9dee..4f2f8f7dc 100644 --- a/docs/assets/audio/README.md +++ b/docs/assets/audio/README.md @@ -1,3 +1,10 @@ +--- +title: "Audio Asset Pipeline" +description: "Audio pipeline index with category status, generation tools, bus architecture, and sprint scope" +type: design +status: active +--- + # Audio Asset Pipeline Status: **Active** — Sprint 7 (first audio sprint) diff --git a/docs/assets/audio/ambient.md b/docs/assets/audio/ambient.md index 45cafbd5e..d0ef724b3 100644 --- a/docs/assets/audio/ambient.md +++ b/docs/assets/audio/ambient.md @@ -1,3 +1,10 @@ +--- +title: "Ambient Audio Assets" +description: "Zone-based ambient loop assets for station base and zone overlays with generation and layering specs" +type: design +status: active +--- + # Ambient — Audio Assets Zone-based ambient loops. Station base plays globally; overlays crossfade based on player zone (hard tile boundary, 1.5-2s audio tween). diff --git a/docs/assets/audio/palette.md b/docs/assets/audio/palette.md index 3cb5d3a5c..f045e93aa 100644 --- a/docs/assets/audio/palette.md +++ b/docs/assets/audio/palette.md @@ -1,3 +1,10 @@ +--- +title: "Audio Palette" +description: "Sonic identity guide covering insert-tech and organic families, station palette, bus architecture, and generation approach" +type: design +status: active +--- + # Audio Palette The sonic identity of The Settled Reach. Living document — updated as the audio language evolves. diff --git a/docs/assets/audio/sfx.md b/docs/assets/audio/sfx.md index a9b5116dd..b85575226 100644 --- a/docs/assets/audio/sfx.md +++ b/docs/assets/audio/sfx.md @@ -1,3 +1,10 @@ +--- +title: "SFX Audio Assets" +description: "World sound effect assets for footsteps, NPC murmur, and environmental events with generation specs" +type: design +status: active +--- + # SFX — Audio Assets World sound effects: footsteps, environmental events, impacts. Event-driven, often positional (AudioStreamPlayer2D). diff --git a/docs/assets/audio/ui.md b/docs/assets/audio/ui.md index 90d71750e..a7e37cb27 100644 --- a/docs/assets/audio/ui.md +++ b/docs/assets/audio/ui.md @@ -1,3 +1,10 @@ +--- +title: "UI Audio Assets" +description: "Interface sound assets for cursor, implant, monologue chimes, and weapon aim with generation specs" +type: design +status: active +--- + # UI — Audio Assets Interface sounds triggered by player interaction, insert systems, and cognitive events. Non-positional (AudioStreamPlayer). Routes to UI Sounds bus. diff --git a/docs/assets/video/README.md b/docs/assets/video/README.md index 865935c8f..8407c1058 100644 --- a/docs/assets/video/README.md +++ b/docs/assets/video/README.md @@ -1,3 +1,10 @@ +--- +title: "Video Asset Pipeline" +description: "Video pipeline index for trailers and cutscenes, deferred to post-v0.1 milestones" +type: design +status: active +--- + # Video Asset Pipeline Status: **Stub** — no video assets planned for v0.1. diff --git a/docs/assets/video/palette.md b/docs/assets/video/palette.md index 21debf081..eef50748c 100644 --- a/docs/assets/video/palette.md +++ b/docs/assets/video/palette.md @@ -1,3 +1,10 @@ +--- +title: "Video Palette" +description: "Motion and editing style guide for video production, to be established post-v0.1" +type: design +status: active +--- + # Video Palette Status: **Stub** — no video production planned for v0.1. diff --git a/docs/assets/visual/README.md b/docs/assets/visual/README.md index db51ca3c6..1e5d885c0 100644 --- a/docs/assets/visual/README.md +++ b/docs/assets/visual/README.md @@ -1,3 +1,10 @@ +--- +title: "Visual Asset Pipeline" +description: "Visual pipeline index covering sprites, furniture, tilesets, icons, and effects with render pipeline overview" +type: design +status: active +--- + # Visual Asset Pipeline Status: **Stub** — awaiting first visual sprint. diff --git a/docs/assets/visual/palette.md b/docs/assets/visual/palette.md index 2ee7991c0..a33965ab8 100644 --- a/docs/assets/visual/palette.md +++ b/docs/assets/visual/palette.md @@ -1,3 +1,10 @@ +--- +title: "Visual Palette" +description: "Art direction guide covering camera angle, entity colours, environmental neutrality, and functional warmth" +type: design +status: active +--- + # Visual Palette Status: **Stub** — reference art direction workshop output for current guidance.