Skip to content

docs: Fix dead links to WIP articles #158

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 23, 2025
Merged

docs: Fix dead links to WIP articles #158

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 9 additions & 4 deletions Sources/EmbeddedSwift/Documentation.docc/SDKSupport/IntegratingWithPlatforms.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,12 @@ Using a bridging header is discouraged when building an entire set of Swift libr

Most embedded platforms use one of these build systems:

1. **CMake** - See <doc:IntegrateWithCMake> for details
2. **Make** - See <doc:IntegrateWithMake> for more information
3. **Platform-specific build tools** - These usually allow integration of custom build steps, and you can always manually invoke the Swift compiler (`swiftc`) with the right flags to produce a .o file that can be further used in the build. Follow the <doc:Basics> article for details.
1. **CMake**.
2. **Make**.
3. **Platform-specific build tools** - These usually allow integration of custom build steps.

For (1) and (2), articles will be added to this documentation in the future.
For (3), it is always possible to manually invoke the Swift compiler (`swiftc`) with the right flags to produce a .o file that can be further used in the build system. Follow the <doc:Basics> article for details.

### Matching platform's ISA and ABI

Expand All @@ -66,7 +69,9 @@ For detailed instructions on integrating with the Raspberry Pi Pico SDK, see <do

### ESP32

For ESP microcontrollers using the ESP-IDF framework, see <doc:IntegrateWithESP>. Note that only chips based on RISC-V architecture (e.g. ESP32-C3, ESP32-C6, ESP32-P4) are supported with Embedded Swift. The Xtensa ISA (used in e.g. ESP8266 or ESP32-S2 and ESP32-S3) is not supported.
Note that only chips based on RISC-V architecture (e.g. ESP32-C3, ESP32-C6, ESP32-P4) are supported with Embedded Swift. The Xtensa ISA (used in e.g. ESP8266 or ESP32-S2 and ESP32-S3) is not supported.

For ESP microcontrollers using the ESP-IDF framework, an article will be added to this documentation in the future.

### STM32

Expand Down
4 changes: 1 addition & 3 deletions Sources/EmbeddedSwift/Documentation.docc/UsingEmbeddedSwift/Basics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,4 @@ It's very common to integrate with existing SDKs in embedded development. This t
2. **Creating a bridging header** that exposes the C functions and types from the SDK to Swift.
3. **Configuring the build system** to compile Swift code with the right flags and link it with the SDK's libraries.

Most embedded SDKs provide a build system integration, commonly with CMake, Make, or their own custom build scripts. At the most basic level, it's always possible to manually call the compiler (`swiftc`) as described above from any build system. This will produce a .o file for the entire Swift module, and then a .o file can typically be directly used in the build system.

For details and concrete examples of how to integrate with more common platforms, SDKs and build systems, see <doc:IntegratingWithPlatforms>.
Most embedded SDKs provide a build system integration, commonly with CMake, Make, or their own custom build scripts. For details and concrete examples of how to integrate with more common platforms, SDKs and build systems, see <doc:IntegratingWithPlatforms>.
Loading