From 46a5219f8e3992123ef53037e51f0df9a993b7bd Mon Sep 17 00:00:00 2001 From: Duncan Tourolle Date: Thu, 20 Aug 2026 19:30:48 +0200 Subject: [PATCH] docs: repair broken relative links - traces-quick-ref.md: the four "where to find requirements" links pointed at README.md, but those anchors (#1-user-requirements and friends) live in requirements.md; the "See Also" links were written as if the file sat at the repo root (docs/traceability.md from inside docs/); and the extraction-script link needed ../ to reach scripts/README.md. - release-checklist.md: the release-notes template linked ../../CHANGELOG.md (one level too deep) and ../../issues + ../../discussions, which are GitHub relative-URL idioms. The canonical remote is Gitea, whose release bodies render the template outside any repo path, so these are now absolute gitea.tourolle.paris URLs. Gitea has no discussions, so that link is dropped rather than pointed somewhere it does not exist. - specs/favorites-browsing.md: linked the deleted src/lib/utils/tauriIntegration.test.ts. --- docs/release-checklist.md | 5 ++--- docs/specs/favorites-browsing.md | 2 +- docs/traces-quick-ref.md | 20 ++++++++++---------- 3 files changed, 13 insertions(+), 14 deletions(-) diff --git a/docs/release-checklist.md b/docs/release-checklist.md index f618cc6f..d4b4c263 100644 --- a/docs/release-checklist.md +++ b/docs/release-checklist.md @@ -255,9 +255,8 @@ First build takes longer (cache warming). Subsequent releases are faster due to **Android:** 8.0+ ### 🔗 Links -- [Changelog](../../CHANGELOG.md) -- [Issues](../../issues) -- [Discussion](../../discussions) +- [Changelog](https://gitea.tourolle.paris/dtourolle/jellytau/src/branch/master/CHANGELOG.md) +- [Issues](https://gitea.tourolle.paris/dtourolle/jellytau/issues) --- Built with Tauri, SvelteKit, and Rust 🦀 diff --git a/docs/specs/favorites-browsing.md b/docs/specs/favorites-browsing.md index ce2adf6b..7a95960b 100644 --- a/docs/specs/favorites-browsing.md +++ b/docs/specs/favorites-browsing.md @@ -332,7 +332,7 @@ Frontend (`bun run test`): |------|--------| | UT-105 | `favorites` store override precedence: store value beats `userData.isFavorite` beats `false` | | UT-106 | Un-hearting removes the item from a favourites list view (pure logic extracted to a `.ts` module, per the TrackList/episodeStrip pattern) | -| IT-0xx | `repositoryGetFavorites` param naming — add to [tauriIntegration.test.ts](../../src/lib/utils/tauriIntegration.test.ts): camelCase top-level params, scope serialised as `"movies"` etc. | +| IT-0xx | `repositoryGetFavorites` param naming — add to the IPC param-naming suite under `src/lib/utils/` (`tauriIntegration.test.ts` no longer exists — see the current camelCase guards in `src/lib/stores/`): camelCase top-level params, scope serialised as `"movies"` etc. | Any component logic worth testing gets extracted into a plain `.ts` module first (`favoritesView.ts`), rather than tested through the component. diff --git a/docs/traces-quick-ref.md b/docs/traces-quick-ref.md index f9766e33..99853324 100644 --- a/docs/traces-quick-ref.md +++ b/docs/traces-quick-ref.md @@ -52,10 +52,10 @@ fn test_queue_next() { ## Where to Find Requirements -1. **User Requirements (UR):** [README.md](README.md#1-user-requirements) -2. **Integration Requirements (IR):** [README.md](README.md#21-integration-requirements) -3. **Development Requirements (DR):** [README.md](README.md#23-development-requirements) -4. **Jellyfin API (JA):** [README.md](README.md#22-jellyfin-api-requirements) +1. **User Requirements (UR):** [requirements.md](requirements.md#1-user-requirements) +2. **Integration Requirements (IR):** [requirements.md](requirements.md#21-integration-requirements) +3. **Development Requirements (DR):** [requirements.md](requirements.md#23-development-requirements) +4. **Jellyfin API (JA):** [requirements.md](requirements.md#22-jellyfin-api-requirements) ## How to Add TRACES @@ -139,13 +139,13 @@ bun run traces:json | jq '.requirements."UR-005"' ## CI/CD Validation The workflow automatically checks: -- ✅ Coverage stays >= 82% (a ratchet — raise it, never lower it) +- ✅ Coverage stays >= 88% (a ratchet — raise it, never lower it) - ✅ Every traced ID is defined in `docs/requirements.md` - ✅ New files have TRACES - ✅ JSON format is valid - ✅ Reports are generated -See [traceability-ci.md](docs/traceability-ci.md) for details. +See [traceability-ci.md](traceability-ci.md) for details. ## Tips & Tricks @@ -199,10 +199,10 @@ A: Yes! TRACES show your implementation plan. ## See Also -- [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) +- [Full Traceability Matrix](traceability.md) +- [CI/CD Pipeline Guide](traceability-ci.md) +- [Requirements Specification](requirements.md) +- [Extraction Script](../scripts/README.md#extract-tracests) ---