Skip to content

A self-hosted media server and file management system

feat: temporary feature documentation

aminnausinc1f2d4a8e30c
diff --git a/.github/ISSUE_TEMPLATE/feature.md b/.github/ISSUE_TEMPLATE/feature.md
new file mode 100644
index 00000000..aa0508ba
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature.md
@@ -0,0 +1,77 @@
+# 🎯 Feature: Lyrics Search & Submission via LRCLib
+
+## πŸ“š Overview
+
+<!-- What's the goal of this feature? What problem does it solve? -->
+
+When a song has no lyrics, users can search LRCLib for matches, preview options, and confirm the correct lyrics to save.
+
+---
+
+### 🧭 User Flow
+
+<!-- Step-by-step of what the user does -->
+
+1. Song has no lyrics β†’ user opens lyric viewer and sees related message
+2. User presses edit lyrics button β†’ opens dedicated modal for lyrics with a built in mp3 player and import / save / cancel buttons
+3. User clicks β†’ fetch results from LRCLib.
+4. Display possible matches (`artist - title`).
+5. User selects one β†’ save it locally and load it in the viewer.
+6. User confirms β†’ save lyrics to video.
+
+---
+
+### 🧱 Technical Plan
+
+#### Components Involved
+
+- `LyricsViewer.vue`: Entry point, shows search button
+- `LyricsEditorForm.vue`: Edit, Confirm, Cancel, Reset
+- `LyricsGenerator.vue`: Search, Select
+- `lyricsService.ts`: Fetches from LRCLib API
+- `ExternalMetadataController.php` : Fetches metadata from external sources (LRCLib, anidb, imdb)
+- `MetadataController.php`: Saves lyrics to metadata (use existing function)
+
+#### API Endpoints
+
+- `GET /api/metadata/:id/import/lyrics` (proxy fetch and parse full metadata serverside)
+
+---
+
+### βœ… Acceptance Criteria
+
+- [ ] "Import Lyrics" button appears in edit modal if no lyrics exist
+- [ ] Modal allows listing of multiple matches with the styling of lrclib (lots of metadata)
+- [ ] User can confirm and attach lyrics
+- [ ] Lyrics appear immediately in viewer once added
+- [ ] Lyrics are saved to database upon saving modal
+- [ ] Errors and edge cases are handled (e.g., no results, network failure on import or save)
+- [ ] User must be warned if they are replacing existing lyrics
+
+---
+
+### πŸ§ͺ Testing Plan
+
+#### Unit
+
+- [ ] `lyricsService` fetch returns correct data
+- [ ] Modal state changes on selection/confirm
+
+#### Integration
+
+- [ ] End-to-end search β†’ confirm β†’ display flow
+
+#### Manual Test
+
+- [ ] Try with a known match
+- [ ] Try with no match
+- [ ] Cancel mid-flow
+
+---
+
+### πŸ“Œ Notes / Questions
+
+<!-- Open questions, blockers, tradeoffs -->
+
+- Should users be allowed to edit the lyrics after confirmation?
+- Cache LRCLib results locally?
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
new file mode 100644
index 00000000..eddfdac9
--- /dev/null
+++ b/.github/pull_request_template.md
@@ -0,0 +1,15 @@
+### Fixes
+
+- Fixed Bugs
+
+### Changes
+
+- Changed Functionality
+
+### Additions
+
+- New Features
+
+### Demo
+
+- Pictures
diff --git a/doc/features/account-management.md b/doc/features/account-management.md
new file mode 100644
index 00000000..2fdbaacd
--- /dev/null
+++ b/doc/features/account-management.md
@@ -0,0 +1,37 @@
+# Feature: ?
+
+**Issue**:
+
+## Overview
+
+What does this feature do or what is it for?
+
+### Goals
+
+- What value does it provide?
+- What changes when this feature is complete?
+
+### User Flow
+
+1. User does x
+2. User selects y
+3. User confirms z
+
+### Tech Plan
+
+- Component: LyricsSearchModal.vue
+- API: GET /lyrics/search β†’ proxy LRCLib
+- Store lyrics via PATCH /videos/:id/lyrics
+
+### Edge Cases
+
+- Simple list of edge cases
+
+### Testing
+
+- Unit: service.test.ts
+- Integration: full user flow ?
+
+### Issue Tracker
+
+- List the issues or pull requests connected to this feature
diff --git a/doc/templates/feature-template.md b/doc/templates/feature-template.md
new file mode 100644
index 00000000..46cbc17d
--- /dev/null
+++ b/doc/templates/feature-template.md
@@ -0,0 +1,37 @@
+# Feature: ?
+
+**Issue**:
+
+## Overview
+
+What does this feature do or what is it for?
+
+### Goals
+
+- What value does it provide?
+- What changes when this feature is complete?
+
+### User Flow
+
+1. User does x
+2. User selects y
+3. User confirms z
+
+### Tech Plan
+
+- Component: test.vue
+- API: GET /search β†’ proxy api
+- Store via PATCH /test/:id
+
+### Edge Cases
+
+- Simple list of edge cases
+
+### Testing
+
+- Unit: service.test.ts
+- Integration: full user flow ?
+
+### Issue Tracker
+
+- List the issues or pull requests connected to this feature
diff --git a/resources/js/components/forms/EditVideo.vue b/resources/js/components/forms/EditVideo.vue
index ce2259d1..d4adf1a5 100755
--- a/resources/js/components/forms/EditVideo.vue
+++ b/resources/js/components/forms/EditVideo.vue
@@ -49,7 +49,7 @@ const fields = reactive<FormField[]>([
},
{
name: 'lyrics',
- text: `Embedded ${isAudio.value ? 'Lyrics' : 'Captions'} (Uneditable)`,
+ text: `Embedded ${isAudio.value ? 'Lyrics' : 'Captions'}`,
type: 'textArea',
value: props.video?.metadata?.lyrics,
subtext: 'Format: [mm:ss] line',