Skip to content

Commit cfac7f3

Browse files
Update links and tweak text on Embedded use case page (#990)
* Update links and tweak text on Embedded use case page * Update _data/new-data/get-started/embedded/card-grid.yml * Update _data/new-data/get-started/embedded/card-grid.yml * Update _data/new-data/get-started/embedded/hero.yml * Apply suggestions from code review --------- Co-authored-by: Mishal Shah <shahmishal@users.noreply.github.com>
1 parent 53f9cdb commit cfac7f3

File tree

7 files changed

+23
-14
lines changed

7 files changed

+23
-14
lines changed

_data/new-data/get-started/embedded/card-grid.yml

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,15 @@ tertiary_cards:
66
- name: "Integrate with Raspberry Pi Pico SDK"
77
text: "Take advantage of seamless interoperatibility and use existing APIs from the Pico SDK directly from your Swift code."
88
link_text: Open guide
9-
link: https://swiftpackageindex.com/apple/swift-embedded-examples/main/documentation/embeddedswift/integratewithpico
9+
link: https://docs.swift.org/embedded/documentation/embedded/picoguide
1010
- name: "Go baremetal on STM32 chips"
1111
text: "For maximum control, you can run completely baremetal and use Swift MMIO to operate hardware devices."
1212
link_text: Open guide
1313
link: https://swiftpackageindex.com/apple/swift-embedded-examples/main/documentation/embeddedswift/stm32baremetalguide
14-
paragraph:
14+
text:
1515
Embedded Swift is not limited to specific hardware devices or platforms. It's versatile, it can be integrated with
16-
existing SDKs and build systems, and it can also be used for pure baremetal development. Most commonly used ARM
17-
and RISC-V chips can be targeted by the Swift toolchain.
16+
existing SDKs and build systems, and it can also be used for pure baremetal development. Most common ARM
17+
and RISC-V chips can be targeted by the Swift toolchain.
18+
link:
19+
url: https://docs.swift.org/embedded/documentation/embedded/integratingwithplatforms
20+
text: Learn more about integration with other platforms and build systems

_data/new-data/get-started/embedded/code-image-column.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ code: |-
2424
}
2525
}
2626
}
27-
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.
27+
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.
2828
link:
2929
url: https://www.swift.org/blog/byte-sized-swift-tiny-games-playdate/
3030
text: Learn more
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
headline: Create embedded software with Swift
22
body: Develop efficient, reliable firmware for devices like microcontrollers
33
link:
4-
url: /getting-started/embedded-swift
4+
url: https://docs.swift.org/embedded/documentation/embedded/waystogetstarted
55
text: Get Started
66
boxes:
77
- title: Safe
88
text: Eliminate buffer overruns and null‑pointer crashes at compile time, keeping your firmware dependable and robust.
99
- title: Interoperable
1010
text: Reuse existing C/C++ drivers and SDKs with zero wrappers or runtime glue, integrating in minutes.
1111
- title: Tiny
12-
text: Produce meaningful programs measured in kilobytes that are capable of running on constrained devices with no hidden overhead.
12+
text: Produce meaningful programs measured in kilobytes that are capable of running on constrained devices with no hidden overhead.

_data/new-data/get-started/embedded/link-columns.yml

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,10 @@ headline: Learn more
22
columns:
33
- headline: Documentation
44
links:
5-
- text: Build an embedded app for a microcontroller
6-
url: '/getting-started/embedded-swift/'
5+
- text: Embedded Swift documentation
6+
url: 'https://docs.swift.org/embedded/documentation/embedded'
7+
- text: Getting started with Embedded Swift
8+
url: 'https://docs.swift.org/embedded/documentation/embedded/waystogetstarted'
79
- text: Embedded Swift vision document
810
url: 'https://github.com/swiftlang/swift-evolution/blob/main/visions/embedded-swift.md'
911
- text: Embedded Swift example projects
@@ -21,4 +23,4 @@ columns:
2123
- text: Embedded category on Swift forums
2224
url: 'https://forums.swift.org/c/development/embedded/107'
2325
- text: Embedded Swift community hour
24-
url: 'https://forums.swift.org/t/embedded-swift-community-hour-may-9-2025/79647/'
26+
url: 'https://forums.swift.org/t/embedded-swift-community-hour-may-9-2025/79647/'

_data/new-data/get-started/embedded/primary-content.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ secondary_cards:
2020
logo: /assets/images/get-started/interactive-ui-examples@2x.png
2121
text: Build projects using the popular embedded graphics library LVGL on an STM32 board for rich UI and touch input.
2222
link_text: Learn more
23-
link: https://github.com/apple/swift-embedded-examples/pull/104
23+
link: https://github.com/apple/swift-embedded-examples/tree/main/stm32-lvgl
2424

2525
- name: PlaydateKit
2626
logo: /assets/images/get-started/playdate-kit@2x.png
@@ -31,4 +31,4 @@ secondary_cards:
3131

3232
link:
3333
url: https://github.com/apple/swift-embedded-examples
34-
text: Explore more Embedded Swift examples and templates on Github
34+
text: Explore more Embedded Swift examples and templates on Github

_includes/new-includes/components/card-grid.html

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,11 @@ <h2>{{ include.content.title }}</h2>
5050
</li>
5151
{% endfor %}
5252
</ul>
53-
{% endif %} {% if include.content.link %}
53+
{% endif %}
54+
{% if include.content.text %}
55+
<p>{{ include.content.text }}</p>
56+
{% endif %}
57+
{% if include.content.link %}
5458
<a href="{{ include.content.link.url }}"
5559
>{{ include.content.link.text }}
5660
</a>

get-started/embedded/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ title: Embedded
1212
<!-- Runs on many embedded platforms -->
1313

1414
<style>
15-
.hero-card { aspect-ratio: auto; width: auto; }
15+
.card-grid p { margin-bottom: 20px; }
1616
</style>
1717
{% include new-includes/components/card-grid.html content = site.data.new-data.get-started.embedded.card-grid %}
1818

0 commit comments

Comments
 (0)