fix: Address markdown linting issues from CodeRabbit review

- Wrap bare URLs in angle brackets in CLAUDE.md (MD034)
- Add language specifiers to fenced code blocks (MD040):
  - `text` for directory structures and ASCII diagrams
  - `http` for HTTP request examples

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
Andrew BeveridgeandClaude Opus 4.5 committed 2025-12-28 02:58:22 -05:00
1 parent 986a5e499f
commit a3f0c08f99
3 files changed
+20 -20

No files matched your search

+3 -3
View File
@@ -4,9 +4,9 @@
**Karaoke video generation platform** - CLI tool and web service that creates professional karaoke videos with synchronized lyrics.
- **Production**: https://gen.nomadkaraoke.com (frontend), https://api.nomadkaraoke.com (backend)
- **Production**: <https://gen.nomadkaraoke.com> (frontend), <https://api.nomadkaraoke.com> (backend)
- **CLI**: `karaoke-gen` (local), `karaoke-gen-remote` (cloud)
- **Repo**: https://github.com/nomadkaraoke/karaoke-gen
- **Repo**: <https://github.com/nomadkaraoke/karaoke-gen>
## Quick Reference
@@ -57,7 +57,7 @@ cd frontend && npm run test:all 2>&1 | tail -n 200
## Documentation Maintenance
### Structure
```
```text
docs/
├── README.md # Current status + navigation (UPDATE THIS)
├── ARCHITECTURE.md # System design
+13 -13
View File
@@ -14,7 +14,7 @@ curl -H "Authorization: Bearer YOUR_TOKEN" ...
### Health
```
```http
GET /health
```
@@ -24,7 +24,7 @@ No auth required. Returns service status.
#### Create Job with Upload
```
```http
POST /api/jobs/upload
Content-Type: multipart/form-data
@@ -37,7 +37,7 @@ Returns job ID. Triggers async processing.
#### Get Job Status
```
```http
GET /api/jobs/{job_id}
```
@@ -49,7 +49,7 @@ Response includes:
#### List Jobs
```
```http
GET /api/jobs
GET /api/jobs?status=complete
GET /api/jobs?limit=10&offset=0
@@ -57,7 +57,7 @@ GET /api/jobs?limit=10&offset=0
#### Delete Job
```
```http
DELETE /api/jobs/{job_id}
```
@@ -65,7 +65,7 @@ DELETE /api/jobs/{job_id}
#### Get Correction Data
```
```http
GET /api/review/{job_id}/correction-data
```
@@ -73,7 +73,7 @@ Returns lyrics correction data for the review UI.
#### Complete Review
```
```http
POST /api/review/{job_id}/complete
Content-Type: application/json
@@ -87,7 +87,7 @@ Saves corrections and triggers video rendering.
#### Generate Preview
```
```http
POST /api/review/{job_id}/preview-video
```
@@ -95,7 +95,7 @@ Generates preview video during review.
#### Stream Audio
```
```http
GET /api/review/{job_id}/audio/{stem_type}
```
@@ -103,7 +103,7 @@ Streams audio for review playback.
### Instrumental Selection
```
```http
POST /api/jobs/{job_id}/select-instrumental
Content-Type: application/json
@@ -114,7 +114,7 @@ Content-Type: application/json
### Audio Search
```
```http
GET /api/audio-search?q=song+name
```
@@ -122,7 +122,7 @@ Search for songs (flacfetch integration).
### Themes
```
```http
GET /api/themes
```
@@ -132,7 +132,7 @@ No auth required. Returns available video themes.
These endpoints are used by workers and require admin tokens.
```
```http
POST /api/internal/jobs/{job_id}/trigger-audio
POST /api/internal/jobs/{job_id}/trigger-lyrics
POST /api/internal/jobs/{job_id}/trigger-screens
+4 -4
View File
@@ -2,7 +2,7 @@
## System Overview
```
```text
┌─────────────────────────────────────────────────────────────────┐
│ Frontend (Cloudflare Pages) │
│ Next.js + TypeScript │
@@ -33,7 +33,7 @@
## Processing Pipeline
```
```text
1. UPLOAD
POST /api/jobs/upload
• Save audio to GCS
@@ -95,7 +95,7 @@
## GCS File Structure
```
```text
jobs/{job_id}/
├── input/
│ └── original.flac # Uploaded audio
@@ -124,7 +124,7 @@ jobs/{job_id}/
**Key Design Decision**: We use LyricsTranscriber as a **library**, not a server.
```
```text
CLI Mode (Original): Cloud Mode (Our Approach):
──────────────────── ──────────────────────────
LyricsTranscriber LyricsTranscriber