From 1cd845045cf8dd6547d973eef0df4945e05648ee Mon Sep 17 00:00:00 2001 From: Kuba Mracek Date: Wed, 28 May 2025 14:04:15 -0700 Subject: [PATCH 1/5] Update links and tweak text on Embedded use case page --- _data/new-data/get-started/embedded/card-grid.yml | 11 +++++++---- .../get-started/embedded/code-image-column.yml | 2 +- _data/new-data/get-started/embedded/hero.yml | 4 ++-- _data/new-data/get-started/embedded/link-columns.yml | 8 +++++--- .../new-data/get-started/embedded/primary-content.yml | 4 ++-- _includes/new-includes/components/card-grid.html | 6 +++++- get-started/embedded/index.md | 2 +- 7 files changed, 23 insertions(+), 14 deletions(-) diff --git a/_data/new-data/get-started/embedded/card-grid.yml b/_data/new-data/get-started/embedded/card-grid.yml index 922d857ed..930553f8d 100644 --- a/_data/new-data/get-started/embedded/card-grid.yml +++ b/_data/new-data/get-started/embedded/card-grid.yml @@ -6,12 +6,15 @@ tertiary_cards: - name: "Integrate with Raspberry Pi Pico SDK" text: "Take advantage of seamless interoperatibility and use existing APIs from the Pico SDK directly from your Swift code." link_text: Open guide - link: https://swiftpackageindex.com/apple/swift-embedded-examples/main/documentation/embeddedswift/integratewithpico + link: https://swiftpackageindex.com/apple/swift-embedded-examples/main/documentation/embeddedswift/picoguide - name: "Go baremetal on STM32 chips" text: "For maximum control, you can run completely baremetal and use Swift MMIO to operate hardware devices." link_text: Open guide link: https://swiftpackageindex.com/apple/swift-embedded-examples/main/documentation/embeddedswift/stm32baremetalguide -paragraph: +text: Embedded Swift is not limited to specific hardware devices or platforms. It's versatile, it can be integrated with - existing SDKs and build systems, and it can also be used for pure baremetal development. Most commonly used ARM - and RISC-V chips can be targeted by the Swift toolchain. \ No newline at end of file + existing SDKs and build systems, and it can also be used for pure baremetal development. Most common ARM + and RISC-V chips can be targeted by the Swift toolchain. +link: + url: https://swiftpackageindex.com/apple/swift-embedded-examples/main/documentation/embeddedswift/integratingwithplatforms + text: Learn more about integration with other platforms and build systems diff --git a/_data/new-data/get-started/embedded/code-image-column.yml b/_data/new-data/get-started/embedded/code-image-column.yml index 49cb0d9fb..bbe61bfd7 100644 --- a/_data/new-data/get-started/embedded/code-image-column.yml +++ b/_data/new-data/get-started/embedded/code-image-column.yml @@ -24,7 +24,7 @@ code: |- } } } -body: In just 788 bytes, Embedded Swift powers Conway’s Game of Life on the Playdate handheld—melding high‑level abstractions with low‑level bit‑twiddling for real‑time animation. +body: In just 788 bytes of resulting compiled code, Embedded Swift powers Conway’s Game of Life on the Playdate handheld—melding high‑level abstractions with low‑level bit‑twiddling for real‑time animation. link: url: https://www.swift.org/blog/byte-sized-swift-tiny-games-playdate/ text: Learn more diff --git a/_data/new-data/get-started/embedded/hero.yml b/_data/new-data/get-started/embedded/hero.yml index d6bdcde69..92c7d5a39 100644 --- a/_data/new-data/get-started/embedded/hero.yml +++ b/_data/new-data/get-started/embedded/hero.yml @@ -1,7 +1,7 @@ headline: Create embedded software with Swift body: Develop efficient, reliable firmware for devices like microcontrollers link: - url: /getting-started/embedded-swift + url: https://swiftpackageindex.com/apple/swift-embedded-examples/main/documentation/embeddedswift/waystogetstarted text: Get Started boxes: - title: Safe @@ -9,4 +9,4 @@ boxes: - title: Interoperable text: Reuse existing C/C++ drivers and SDKs with zero wrappers or runtime glue, integrating in minutes. - title: Tiny - text: Produce meaningful programs measured in kilobytes that are capable of running on constrained devices with no hidden overhead. \ No newline at end of file + text: Produce meaningful programs measured in kilobytes that are capable of running on constrained devices with no hidden overhead. diff --git a/_data/new-data/get-started/embedded/link-columns.yml b/_data/new-data/get-started/embedded/link-columns.yml index 6bb9b0260..cd9fdaa21 100644 --- a/_data/new-data/get-started/embedded/link-columns.yml +++ b/_data/new-data/get-started/embedded/link-columns.yml @@ -2,8 +2,10 @@ headline: Learn more columns: - headline: Documentation links: - - text: Build an embedded app for a microcontroller - url: '/getting-started/embedded-swift/' + - text: Embedded Swift documentation + url: 'https://swiftpackageindex.com/apple/swift-embedded-examples/main/documentation/embeddedswift' + - text: Getting started with Embedded Swift + url: 'https://swiftpackageindex.com/apple/swift-embedded-examples/main/documentation/embeddedswift/waystogetstarted' - text: Embedded Swift vision document url: 'https://github.com/swiftlang/swift-evolution/blob/main/visions/embedded-swift.md' - text: Embedded Swift example projects @@ -21,4 +23,4 @@ columns: - text: Embedded category on Swift forums url: 'https://forums.swift.org/c/development/embedded/107' - text: Embedded Swift community hour - url: 'https://forums.swift.org/t/embedded-swift-community-hour-may-9-2025/79647/' \ No newline at end of file + url: 'https://forums.swift.org/t/embedded-swift-community-hour-may-9-2025/79647/' diff --git a/_data/new-data/get-started/embedded/primary-content.yml b/_data/new-data/get-started/embedded/primary-content.yml index 461b2c5c6..1558c6402 100644 --- a/_data/new-data/get-started/embedded/primary-content.yml +++ b/_data/new-data/get-started/embedded/primary-content.yml @@ -20,7 +20,7 @@ secondary_cards: logo: /assets/images/get-started/interactive-ui-examples@2x.png text: Build projects using the popular embedded graphics library LVGL on an STM32 board for rich UI and touch input. link_text: Learn more - link: https://github.com/apple/swift-embedded-examples/pull/104 + link: https://github.com/apple/swift-embedded-examples/tree/main/stm32-lvgl - name: PlaydateKit logo: /assets/images/get-started/playdate-kit@2x.png @@ -31,4 +31,4 @@ secondary_cards: link: url: https://github.com/apple/swift-embedded-examples - text: Explore more Embedded Swift examples and templates on Github \ No newline at end of file + text: Explore more Embedded Swift examples and templates on Github diff --git a/_includes/new-includes/components/card-grid.html b/_includes/new-includes/components/card-grid.html index 056439c33..f01db6820 100644 --- a/_includes/new-includes/components/card-grid.html +++ b/_includes/new-includes/components/card-grid.html @@ -50,7 +50,11 @@

{{ include.content.title }}

{% endfor %} - {% endif %} {% if include.content.link %} + {% endif %} + {% if include.content.text %} +

{{ include.content.text }}

+ {% endif %} + {% if include.content.link %} {{ include.content.link.text }} diff --git a/get-started/embedded/index.md b/get-started/embedded/index.md index 0124c055e..4c47a6934 100644 --- a/get-started/embedded/index.md +++ b/get-started/embedded/index.md @@ -12,7 +12,7 @@ title: Embedded {% include new-includes/components/card-grid.html content = site.data.new-data.get-started.embedded.card-grid %} From 39e7cb4cab004f23d5d652c22993854b47c0ca9c Mon Sep 17 00:00:00 2001 From: Mishal Shah Date: Fri, 30 May 2025 00:16:38 -0700 Subject: [PATCH 2/5] Update _data/new-data/get-started/embedded/card-grid.yml --- _data/new-data/get-started/embedded/card-grid.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_data/new-data/get-started/embedded/card-grid.yml b/_data/new-data/get-started/embedded/card-grid.yml index 930553f8d..fe2301bd0 100644 --- a/_data/new-data/get-started/embedded/card-grid.yml +++ b/_data/new-data/get-started/embedded/card-grid.yml @@ -6,7 +6,7 @@ tertiary_cards: - name: "Integrate with Raspberry Pi Pico SDK" text: "Take advantage of seamless interoperatibility and use existing APIs from the Pico SDK directly from your Swift code." link_text: Open guide - link: https://swiftpackageindex.com/apple/swift-embedded-examples/main/documentation/embeddedswift/picoguide + link: https://docs.swift.org/embedded/documentation/embedded/picoguide - name: "Go baremetal on STM32 chips" text: "For maximum control, you can run completely baremetal and use Swift MMIO to operate hardware devices." link_text: Open guide From b1b55831d4d19d72385bf8463f33da6452fa7ff6 Mon Sep 17 00:00:00 2001 From: Mishal Shah Date: Fri, 30 May 2025 00:16:51 -0700 Subject: [PATCH 3/5] Update _data/new-data/get-started/embedded/card-grid.yml --- _data/new-data/get-started/embedded/card-grid.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_data/new-data/get-started/embedded/card-grid.yml b/_data/new-data/get-started/embedded/card-grid.yml index fe2301bd0..af86fa840 100644 --- a/_data/new-data/get-started/embedded/card-grid.yml +++ b/_data/new-data/get-started/embedded/card-grid.yml @@ -16,5 +16,5 @@ text: existing SDKs and build systems, and it can also be used for pure baremetal development. Most common ARM and RISC-V chips can be targeted by the Swift toolchain. link: - url: https://swiftpackageindex.com/apple/swift-embedded-examples/main/documentation/embeddedswift/integratingwithplatforms + url: https://docs.swift.org/embedded/documentation/embedded/integratingwithplatforms text: Learn more about integration with other platforms and build systems From 3d19330a051e014dc6d983be2f5239452a537c36 Mon Sep 17 00:00:00 2001 From: Mishal Shah Date: Fri, 30 May 2025 00:16:58 -0700 Subject: [PATCH 4/5] Update _data/new-data/get-started/embedded/hero.yml --- _data/new-data/get-started/embedded/hero.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_data/new-data/get-started/embedded/hero.yml b/_data/new-data/get-started/embedded/hero.yml index 92c7d5a39..c08866354 100644 --- a/_data/new-data/get-started/embedded/hero.yml +++ b/_data/new-data/get-started/embedded/hero.yml @@ -1,7 +1,7 @@ headline: Create embedded software with Swift body: Develop efficient, reliable firmware for devices like microcontrollers link: - url: https://swiftpackageindex.com/apple/swift-embedded-examples/main/documentation/embeddedswift/waystogetstarted + url: https://docs.swift.org/embedded/documentation/embedded/waystogetstarted text: Get Started boxes: - title: Safe From da116ad3a98d1697502f51fac878b70f5a4e48c3 Mon Sep 17 00:00:00 2001 From: Mishal Shah Date: Fri, 30 May 2025 00:17:52 -0700 Subject: [PATCH 5/5] Apply suggestions from code review --- _data/new-data/get-started/embedded/link-columns.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/_data/new-data/get-started/embedded/link-columns.yml b/_data/new-data/get-started/embedded/link-columns.yml index cd9fdaa21..7874d0cc8 100644 --- a/_data/new-data/get-started/embedded/link-columns.yml +++ b/_data/new-data/get-started/embedded/link-columns.yml @@ -3,9 +3,9 @@ columns: - headline: Documentation links: - text: Embedded Swift documentation - url: 'https://swiftpackageindex.com/apple/swift-embedded-examples/main/documentation/embeddedswift' + url: 'https://docs.swift.org/embedded/documentation/embedded' - text: Getting started with Embedded Swift - url: 'https://swiftpackageindex.com/apple/swift-embedded-examples/main/documentation/embeddedswift/waystogetstarted' + url: 'https://docs.swift.org/embedded/documentation/embedded/waystogetstarted' - text: Embedded Swift vision document url: 'https://github.com/swiftlang/swift-evolution/blob/main/visions/embedded-swift.md' - text: Embedded Swift example projects