From 37450ce5b846654c833aa0336a5b737cb59de299 Mon Sep 17 00:00:00 2001 From: Joe Heck Date: Thu, 30 Jul 2026 16:43:49 -0700 Subject: [PATCH] placeholder for a Windows platform doc catalog --- scripts/navigation.json | 3 ++- scripts/sources.json | 6 ++++++ windows/Package.swift | 19 +++++++++++++++++++ windows/Snippets/.gitkeep | 0 .../SwiftWindows.docc/Documentation.md | 14 ++++++++++++++ windows/Sources/SwiftWindows.docc/building.md | 5 +++++ .../SwiftWindows.docc/getting-started.md | 5 +++++ .../porting-swift-packages.md | 5 +++++ windows/Sources/_empty.swift | 13 +++++++++++++ 9 files changed, 69 insertions(+), 1 deletion(-) create mode 100644 windows/Package.swift create mode 100644 windows/Snippets/.gitkeep create mode 100644 windows/Sources/SwiftWindows.docc/Documentation.md create mode 100644 windows/Sources/SwiftWindows.docc/building.md create mode 100644 windows/Sources/SwiftWindows.docc/getting-started.md create mode 100644 windows/Sources/SwiftWindows.docc/porting-swift-packages.md create mode 100644 windows/Sources/_empty.swift diff --git a/scripts/navigation.json b/scripts/navigation.json index fcfc59ab4..7aefea905 100644 --- a/scripts/navigation.json +++ b/scripts/navigation.json @@ -33,7 +33,8 @@ { "source": "swift-android", "path": "/documentation/swiftandroid", "title": "Android" }, { "source": "embedded-swift", "path": "/documentation/embeddedswift", "title": "Embedded Swift" }, { "source": "swift-linux", "path": "/documentation/swiftlinux", "title": "Linux" }, - { "source": "swift-wasm", "path": "/documentation/wasmguide", "title": "WebAssembly (Wasm)"} + { "source": "swift-wasm", "path": "/documentation/wasmguide", "title": "WebAssembly (Wasm)"}, + { "source": "swift-windows", "path": "/documentation/swiftwindows", "title": "Windows" } ] }, { diff --git a/scripts/sources.json b/scripts/sources.json index 154a730be..87ee422ff 100644 --- a/scripts/sources.json +++ b/scripts/sources.json @@ -77,6 +77,12 @@ "path": "linux", "targets": ["SwiftLinux"] }, + { + "id": "swift-windows", + "type": "local", + "path": "windows", + "targets": ["SwiftWindows"] + }, { "id": "official-libraries", "type": "local", diff --git a/windows/Package.swift b/windows/Package.swift new file mode 100644 index 000000000..933c686be --- /dev/null +++ b/windows/Package.swift @@ -0,0 +1,19 @@ +// swift-tools-version: 6.2 + +import PackageDescription + +let package = Package( + name: "SwiftWindows", + products: [ + .library(name: "SwiftWindows", targets: ["SwiftWindows"]) + ], + dependencies: [ + .package(url: "https://github.com/swiftlang/swift-docc-plugin", from: "1.1.0") + ], + targets: [ + .target( + name: "SwiftWindows", + path: "Sources" + ) + ] +) diff --git a/windows/Snippets/.gitkeep b/windows/Snippets/.gitkeep new file mode 100644 index 000000000..e69de29bb diff --git a/windows/Sources/SwiftWindows.docc/Documentation.md b/windows/Sources/SwiftWindows.docc/Documentation.md new file mode 100644 index 000000000..532f534af --- /dev/null +++ b/windows/Sources/SwiftWindows.docc/Documentation.md @@ -0,0 +1,14 @@ +# ``SwiftWindows`` + +Build and host libraries, apps, and services on Windows. + +@Metadata { + @DisplayName("Windows") + @TitleHeading("") +} + +## Topics + +- +- +- diff --git a/windows/Sources/SwiftWindows.docc/building.md b/windows/Sources/SwiftWindows.docc/building.md new file mode 100644 index 000000000..439a208ff --- /dev/null +++ b/windows/Sources/SwiftWindows.docc/building.md @@ -0,0 +1,5 @@ +# Building for Windows + +Build Swift applications and libraries on Windows. + + diff --git a/windows/Sources/SwiftWindows.docc/getting-started.md b/windows/Sources/SwiftWindows.docc/getting-started.md new file mode 100644 index 000000000..42ef1d1a4 --- /dev/null +++ b/windows/Sources/SwiftWindows.docc/getting-started.md @@ -0,0 +1,5 @@ +# Getting Started + +Set up your environment to develop Swift applications on Windows. + + diff --git a/windows/Sources/SwiftWindows.docc/porting-swift-packages.md b/windows/Sources/SwiftWindows.docc/porting-swift-packages.md new file mode 100644 index 000000000..7ceb37748 --- /dev/null +++ b/windows/Sources/SwiftWindows.docc/porting-swift-packages.md @@ -0,0 +1,5 @@ +# Porting Swift Packages to Windows + +Adapt existing Swift packages so they build and run on Windows. + + diff --git a/windows/Sources/_empty.swift b/windows/Sources/_empty.swift new file mode 100644 index 000000000..1830a90de --- /dev/null +++ b/windows/Sources/_empty.swift @@ -0,0 +1,13 @@ +//===----------------------------------------------------------------------===// +// +// This source file is part of the Swift.org open source project +// +// Copyright (c) 2026 Apple Inc. and the Swift.org project authors +// Licensed under Apache License v2.0 +// +// See LICENSE.txt for license information +// See CONTRIBUTORS.txt for the list of Swift.org project authors +// +// SPDX-License-Identifier: Apache-2.0 +// +//===----------------------------------------------------------------------===//