diff --git a/.gitea/workflows/traceability-check.yml b/.gitea/workflows/traceability-check.yml index 2b568b2..587b78d 100644 --- a/.gitea/workflows/traceability-check.yml +++ b/.gitea/workflows/traceability-check.yml @@ -127,9 +127,9 @@ jobs: run: | echo "" echo "📊 Full Report Generated" - echo "📁 Location: docs/TRACEABILITY.md" + echo "📁 Location: docs/traceability.md" echo "" - head -50 docs/TRACEABILITY.md || true + head -50 docs/traceability.md || true - name: Save artifacts if: always() @@ -138,5 +138,5 @@ jobs: name: traceability-reports path: | traces-report.json - docs/TRACEABILITY.md + docs/traceability.md retention-days: 30 diff --git a/.gitea/workflows/traceability.yml b/.gitea/workflows/traceability.yml index 2fd770f..cee9544 100644 --- a/.gitea/workflows/traceability.yml +++ b/.gitea/workflows/traceability.yml @@ -133,7 +133,7 @@ jobs: uses: actions/upload-artifact@v3 with: name: traceability-report - path: docs/TRACEABILITY.md + path: docs/traceability.md retention-days: 30 - name: Comment PR with coverage report diff --git a/Dockerfile b/Dockerfile index 075a51e..f76dd08 100644 --- a/Dockerfile +++ b/Dockerfile @@ -27,6 +27,14 @@ RUN apt-get update && apt-get install -y --no-install-recommends \ libssl-dev \ libclang-dev \ llvm-dev \ + # Tauri Linux desktop dependencies (needed for `cargo test` on the host target) + libglib2.0-dev \ + libgtk-3-dev \ + libwebkit2gtk-4.1-dev \ + libjavascriptcoregtk-4.1-dev \ + libsoup-3.0-dev \ + librsvg2-dev \ + libayatana-appindicator3-dev \ && rm -rf /var/lib/apt/lists/* # Install Node.js 20.x from NodeSource diff --git a/Dockerfile.builder b/Dockerfile.builder index c5c50b1..3a35de3 100644 --- a/Dockerfile.builder +++ b/Dockerfile.builder @@ -25,6 +25,14 @@ RUN apt-get update && apt-get install -y --no-install-recommends \ libssl-dev \ libclang-dev \ llvm-dev \ + # Tauri Linux desktop dependencies (needed for `cargo test` on the host target) + libglib2.0-dev \ + libgtk-3-dev \ + libwebkit2gtk-4.1-dev \ + libjavascriptcoregtk-4.1-dev \ + libsoup-3.0-dev \ + librsvg2-dev \ + libayatana-appindicator3-dev \ && rm -rf /var/lib/apt/lists/* # Install Node.js 20.x from NodeSource diff --git a/BUILD-BUILDER-IMAGE.md b/build-builder-image.md similarity index 100% rename from BUILD-BUILDER-IMAGE.md rename to build-builder-image.md diff --git a/DOCKER.md b/docker.md similarity index 97% rename from DOCKER.md rename to docker.md index 6b41fc7..20ad755 100644 --- a/DOCKER.md +++ b/docker.md @@ -13,7 +13,7 @@ The setup includes: ### Quick Start **For CI/CD (Gitea Actions)**: -1. Build and push builder image (see [BUILD-BUILDER-IMAGE.md](BUILD-BUILDER-IMAGE.md)) +1. Build and push builder image (see [build-builder-image.md](build-builder-image.md)) 2. Push to master branch - workflow runs automatically 3. Check Actions tab for results and APK artifacts @@ -133,7 +133,7 @@ docker tag jellytau-builder:latest gitea.tourolle.paris/dtourolle/jellytau-build docker push gitea.tourolle.paris/dtourolle/jellytau-builder:latest ``` -See [BUILD-BUILDER-IMAGE.md](BUILD-BUILDER-IMAGE.md) for detailed instructions. +See [build-builder-image.md](build-builder-image.md) for detailed instructions. ### Setting Up Gitea Act diff --git a/docs/BUILD_RELEASE.md b/docs/build-release.md similarity index 100% rename from docs/BUILD_RELEASE.md rename to docs/build-release.md diff --git a/docs/TRACEABILITY_CI.md b/docs/traceability-ci.md similarity index 98% rename from docs/TRACEABILITY_CI.md rename to docs/traceability-ci.md index 5db5ea0..c350162 100644 --- a/docs/TRACEABILITY_CI.md +++ b/docs/traceability-ci.md @@ -138,7 +138,7 @@ The workflow **warns** (but doesn't block) if: 3. Download **traceability-reports** artifact 4. View: - `traces-report.json` - Raw trace data - - `docs/TRACEABILITY.md` - Formatted report + - `docs/traceability.md` - Formatted report ### Locally ```bash @@ -147,7 +147,7 @@ bun run traces:json | jq '.byType' # Generate full report bun run traces:markdown -cat docs/TRACEABILITY.md +cat docs/traceability.md ``` ## Coverage Goals @@ -272,7 +272,7 @@ fi - [Extract Traces Script](../scripts/README.md#extract-tracests) - [Requirements Specification](../README.md#requirements-specification) -- [Traceability Matrix](./TRACEABILITY.md) +- [Traceability Matrix](./traceability.md) - [Gitea Actions Documentation](https://docs.gitea.io/en-us/actions/) ## Support diff --git a/docs/TRACEABILITY.md b/docs/traceability.md similarity index 100% rename from docs/TRACEABILITY.md rename to docs/traceability.md diff --git a/package.json b/package.json index 3c94ae7..b7af95e 100644 --- a/package.json +++ b/package.json @@ -27,7 +27,7 @@ "tauri": "tauri", "traces": "bun run scripts/extract-traces.ts", "traces:json": "bun run scripts/extract-traces.ts --format json", - "traces:markdown": "bun run scripts/extract-traces.ts --format markdown > docs/TRACEABILITY.md" + "traces:markdown": "bun run scripts/extract-traces.ts --format markdown > docs/traceability.md" }, "license": "MIT", "dependencies": { diff --git a/RELEASE_CHECKLIST.md b/release-checklist.md similarity index 100% rename from RELEASE_CHECKLIST.md rename to release-checklist.md diff --git a/scripts/README.md b/scripts/README.md index 9d5389c..4cd2abc 100644 --- a/scripts/README.md +++ b/scripts/README.md @@ -68,7 +68,7 @@ Extract requirement IDs (TRACES) from source code and generate a traceability ma ```bash bun run traces # Generate markdown report bun run traces:json # Generate JSON report -bun run traces:markdown # Save to docs/TRACEABILITY.md +bun run traces:markdown # Save to docs/traceability.md ``` The script scans all TypeScript, Svelte, and Rust files looking for `TRACES:` comments and generates a comprehensive mapping of: @@ -82,7 +82,7 @@ Example TRACES comment in code: function handlePlayback() { ... } ``` -See [docs/TRACEABILITY.md](../docs/TRACEABILITY.md) for the latest generated mapping. +See [docs/traceability.md](../docs/traceability.md) for the latest generated mapping. ### CI/CD Validation @@ -93,8 +93,8 @@ The traceability system is integrated with Gitea Actions CI/CD: - Generates traceability reports automatically For details, see: -- [Traceability CI Guide](../docs/TRACEABILITY_CI.md) - Full CI/CD documentation -- [TRACES Quick Reference](../TRACES_QUICK_REF.md) - Quick guide for adding TRACES +- [Traceability CI Guide](../docs/traceability-ci.md) - Full CI/CD documentation +- [TRACES Quick Reference](../traces-quick-ref.md) - Quick guide for adding TRACES ## Utility Scripts diff --git a/scripts/extract-traces.ts b/scripts/extract-traces.ts index 0685ffb..b9a968a 100644 --- a/scripts/extract-traces.ts +++ b/scripts/extract-traces.ts @@ -5,7 +5,7 @@ * Usage: * bun run scripts/extract-traces.ts * bun run scripts/extract-traces.ts --format json - * bun run scripts/extract-traces.ts --format markdown > docs/TRACEABILITY.md + * bun run scripts/extract-traces.ts --format markdown > docs/traceability.md */ import * as fs from "fs"; diff --git a/SoftwareArchitecture.md b/software-architecture.md similarity index 100% rename from SoftwareArchitecture.md rename to software-architecture.md diff --git a/src-tauri/src/player/session.rs b/src-tauri/src/player/session.rs index 14fe032..f9fa7cb 100644 --- a/src-tauri/src/player/session.rs +++ b/src-tauri/src/player/session.rs @@ -5,7 +5,7 @@ * beyond individual playback states. Enables persistent UI (miniplayer) and * proper transitions between content types. * - * See SoftwareArchitecture.md Section 2.1 for state machine diagram. + * See software-architecture.md Section 2.1 for state machine diagram. */ use log::info; diff --git a/TRACES_QUICK_REF.md b/traces-quick-ref.md similarity index 96% rename from TRACES_QUICK_REF.md rename to traces-quick-ref.md index 6146241..99a05c9 100644 --- a/TRACES_QUICK_REF.md +++ b/traces-quick-ref.md @@ -144,7 +144,7 @@ The workflow automatically checks: - ✅ JSON format is valid - ✅ Reports are generated -See [TRACEABILITY_CI.md](docs/TRACEABILITY_CI.md) for details. +See [traceability-ci.md](docs/traceability-ci.md) for details. ## Tips & Tricks @@ -198,8 +198,8 @@ A: Yes! TRACES show your implementation plan. ## See Also -- [Full Traceability Matrix](docs/TRACEABILITY.md) -- [CI/CD Pipeline Guide](docs/TRACEABILITY_CI.md) +- [Full Traceability Matrix](docs/traceability.md) +- [CI/CD Pipeline Guide](docs/traceability-ci.md) - [Requirements Specification](README.md) - [Extraction Script](scripts/README.md#extract-tracests) @@ -208,5 +208,5 @@ A: Yes! TRACES show your implementation plan. **Quick Start:** 1. Add `// TRACES: UR-XXX` to new code 2. Run `bun run traces:markdown` -3. Check `docs/TRACEABILITY.md` +3. Check `docs/traceability.md` 4. Submit PR - workflow validates automatically! diff --git a/UXFlows.md b/ux-flows.md similarity index 100% rename from UXFlows.md rename to ux-flows.md