From 36bb6c13325d80698dff6df7df55cc64ece88845 Mon Sep 17 00:00:00 2001 From: Vishnu Ravi Date: Sun, 29 Oct 2023 09:11:14 -0400 Subject: [PATCH 1/6] Updates initial setup link --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c5bfadb..8ad2431 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,7 @@ You need to add the Spezi Storage Swift package to [Swift package](https://developer.apple.com/documentation/xcode/creating-a-standalone-swift-package-with-xcode#Add-a-dependency-on-another-Swift-package). > [!IMPORTANT] -> If your application is not yet configured to use Spezi, follow the [Spezi setup article](https://swiftpackageindex.com/stanfordspezi/spezi/documentation/spezi/setup) to set up the core Spezi infrastructure. +> If your application is not yet configured to use Spezi, follow the [Spezi setup article](https://swiftpackageindex.com/stanfordspezi/spezi/documentation/spezi/initial-setup) to set up the core Spezi infrastructure. You can configure the [`LocalStorage`](https://swiftpackageindex.com/stanfordspezi/spezistorage/documentation/spezilocalstorage/localstorage) or [`SecureStorage`](https://swiftpackageindex.com/StanfordSpezi/SpeziStorage/documentation/spezisecurestorage) module in the [`SpeziAppDelegate`](https://swiftpackageindex.com/stanfordspezi/spezi/documentation/spezi/speziappdelegate). ```swift From a5e47de09b313231e08e00c105e2d7b570f594f2 Mon Sep 17 00:00:00 2001 From: Vishnu Ravi Date: Tue, 31 Oct 2023 11:03:32 -0400 Subject: [PATCH 2/6] Add automated link checking --- .github/workflows/pull_request.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.github/workflows/pull_request.yml b/.github/workflows/pull_request.yml index eb53387..bef8f22 100644 --- a/.github/workflows/pull_request.yml +++ b/.github/workflows/pull_request.yml @@ -19,3 +19,6 @@ jobs: swiftlint: name: SwiftLint uses: StanfordSpezi/.github/.github/workflows/swiftlint.yml@v2 + markdown_link_check: + name: Markdown Link Check + uses: StanfordBDHG/.github/.github/workflows/markdown-link-check.yml@2 From 17bd5fa2c35e7bb894149fd1909e59a9cb469bc7 Mon Sep 17 00:00:00 2001 From: Vishnu Ravi Date: Tue, 31 Oct 2023 11:03:41 -0400 Subject: [PATCH 3/6] Add monthly link check --- .../workflows/monthly-markdown-link-check.yml | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 .github/workflows/monthly-markdown-link-check.yml diff --git a/.github/workflows/monthly-markdown-link-check.yml b/.github/workflows/monthly-markdown-link-check.yml new file mode 100644 index 0000000..8e432f0 --- /dev/null +++ b/.github/workflows/monthly-markdown-link-check.yml @@ -0,0 +1,19 @@ +# +# This source file is part of the Stanford Spezi open source project +# +# SPDX-FileCopyrightText: 2023 Stanford University and the project authors (see CONTRIBUTORS.md) +# +# SPDX-License-Identifier: MIT +# + +name: Monthly Markdown Link Check + +on: + # Runs at midnight on the first of every month + schedule: + - cron: "0 0 1 * *" + +jobs: + markdown_link_check: + name: Markdown Link Check + uses: StanfordBDHG/.github/.github/workflows/markdown-link-check.yml@2 \ No newline at end of file From 5961e2413554351d748ca3f9dff33608f7ea670d Mon Sep 17 00:00:00 2001 From: Vishnu Ravi Date: Tue, 31 Oct 2023 13:36:58 -0400 Subject: [PATCH 4/6] Fix reference in workflow --- .github/workflows/pull_request.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/pull_request.yml b/.github/workflows/pull_request.yml index bef8f22..5a7d62c 100644 --- a/.github/workflows/pull_request.yml +++ b/.github/workflows/pull_request.yml @@ -21,4 +21,4 @@ jobs: uses: StanfordSpezi/.github/.github/workflows/swiftlint.yml@v2 markdown_link_check: name: Markdown Link Check - uses: StanfordBDHG/.github/.github/workflows/markdown-link-check.yml@2 + uses: StanfordBDHG/.github/.github/workflows/markdown-link-check.yml@v2 From 77caee973190494f2cb79eba85aae5dddcaec01c Mon Sep 17 00:00:00 2001 From: Vishnu Ravi Date: Tue, 31 Oct 2023 13:37:55 -0400 Subject: [PATCH 5/6] Fix monthly workflow reference --- .github/workflows/monthly-markdown-link-check.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/monthly-markdown-link-check.yml b/.github/workflows/monthly-markdown-link-check.yml index 8e432f0..6c16315 100644 --- a/.github/workflows/monthly-markdown-link-check.yml +++ b/.github/workflows/monthly-markdown-link-check.yml @@ -16,4 +16,4 @@ on: jobs: markdown_link_check: name: Markdown Link Check - uses: StanfordBDHG/.github/.github/workflows/markdown-link-check.yml@2 \ No newline at end of file + uses: StanfordBDHG/.github/.github/workflows/markdown-link-check.yml@v2 \ No newline at end of file From 32d4747db36ba62cbbff0cca8d1d7c7ea458fe5b Mon Sep 17 00:00:00 2001 From: Vishnu Ravi Date: Tue, 31 Oct 2023 13:41:14 -0400 Subject: [PATCH 6/6] Fix all broken links --- .../SpeziLocalStorage.docc/SpeziLocalStorage.md | 2 +- .../SpeziSecureStorage.docc/SpeziSecureStorage.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/Sources/SpeziLocalStorage/SpeziLocalStorage.docc/SpeziLocalStorage.md b/Sources/SpeziLocalStorage/SpeziLocalStorage.docc/SpeziLocalStorage.md index 6dac2a5..7c721bd 100644 --- a/Sources/SpeziLocalStorage/SpeziLocalStorage.docc/SpeziLocalStorage.md +++ b/Sources/SpeziLocalStorage/SpeziLocalStorage.docc/SpeziLocalStorage.md @@ -26,7 +26,7 @@ You need to add the Spezi Storage Swift package to [your app in Xcode](https://developer.apple.com/documentation/xcode/adding-package-dependencies-to-your-app#) or [Swift package](https://developer.apple.com/documentation/xcode/creating-a-standalone-swift-package-with-xcode#Add-a-dependency-on-another-Swift-package). -> Important: If your application is not yet configured to use Spezi, follow the [Spezi setup article](https://swiftpackageindex.com/stanfordspezi/spezi/documentation/spezi/setup) to set up the core Spezi infrastructure. +> Important: If your application is not yet configured to use Spezi, follow the [Spezi setup article](https://swiftpackageindex.com/stanfordspezi/spezi/documentation/spezi/initial-setup) to set up the core Spezi infrastructure. You can configure the ``LocalStorage`` module in the [`SpeziAppDelegate`](https://swiftpackageindex.com/stanfordspezi/spezi/documentation/spezi/speziappdelegate). diff --git a/Sources/SpeziSecureStorage/SpeziSecureStorage.docc/SpeziSecureStorage.md b/Sources/SpeziSecureStorage/SpeziSecureStorage.docc/SpeziSecureStorage.md index 4487f4c..4feeed8 100644 --- a/Sources/SpeziSecureStorage/SpeziSecureStorage.docc/SpeziSecureStorage.md +++ b/Sources/SpeziSecureStorage/SpeziSecureStorage.docc/SpeziSecureStorage.md @@ -26,7 +26,7 @@ You need to add the Spezi Storage Swift package to [your app in Xcode](https://developer.apple.com/documentation/xcode/adding-package-dependencies-to-your-app#) or [Swift package](https://developer.apple.com/documentation/xcode/creating-a-standalone-swift-package-with-xcode#Add-a-dependency-on-another-Swift-package). -> Important: If your application is not yet configured to use Spezi, follow the [Spezi setup article](https://swiftpackageindex.com/stanfordspezi/spezi/documentation/spezi/setup) to set up the core Spezi infrastructure. +> Important: If your application is not yet configured to use Spezi, follow the [Spezi setup article](https://swiftpackageindex.com/stanfordspezi/spezi/documentation/spezi/initial-setup) to set up the core Spezi infrastructure. You can configure the ``SecureStorage`` module in the [`SpeziAppDelegate`](https://swiftpackageindex.com/stanfordspezi/spezi/documentation/spezi/speziappdelegate).