From 3303b164430d9a7055ba484c8ead67a52f7b74f6 Mon Sep 17 00:00:00 2001 From: Ethan Kusters Date: Mon, 14 Mar 2022 11:00:05 -0700 Subject: [PATCH] Prepare documentation for 1.0 release (#6) Resolves rdar://90124447. --- README.md | 8 ++------ .../Getting Started with the Swift-DocC Plugin.md | 4 +--- .../SwiftDocCPlugin.docc/SwiftDocCPlugin.md | 6 ------ 3 files changed, 3 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 13d9aea..57b7e40 100644 --- a/README.md +++ b/README.md @@ -9,9 +9,6 @@ Please see [the plugin's documentation](https://apple.github.io/swift-docc-plugin/documentation/swiftdoccplugin/) for more detailed usage instructions. -**Note:** The Swift-DocC plugin is under **active-development** and is not ready for production -use. - We anticipate releasing a `1.0` version of the Swift-DocC plugin aligned with the release of Swift `5.6`. @@ -24,7 +21,7 @@ let package = Package( // name, platforms, products, etc. dependencies: [ // other dependencies - .package(url: "https://github.com/apple/swift-docc-plugin", branch: "main"), + .package(url: "https://github.com/apple/swift-docc-plugin", from: "1.0.0"), ], targets: [ // targets @@ -32,8 +29,7 @@ let package = Package( ) ``` -Swift 5.6 is required in order to run the plugin. Development snapshots that include Swift 5.6 -can be found on [Swift.org](https://www.swift.org/download/#snapshots). +Swift 5.6 is required in order to run the plugin. ### Converting Documentation diff --git a/Sources/SwiftDocCPluginDocumentation/SwiftDocCPlugin.docc/Getting Started with the Swift-DocC Plugin.md b/Sources/SwiftDocCPluginDocumentation/SwiftDocCPlugin.docc/Getting Started with the Swift-DocC Plugin.md index d92a793..af694c2 100644 --- a/Sources/SwiftDocCPluginDocumentation/SwiftDocCPlugin.docc/Getting Started with the Swift-DocC Plugin.md +++ b/Sources/SwiftDocCPluginDocumentation/SwiftDocCPlugin.docc/Getting Started with the Swift-DocC Plugin.md @@ -11,7 +11,7 @@ let package = Package( // name, platforms, products, etc. dependencies: [ // other dependencies - .package(url: "https://github.com/apple/swift-docc-plugin", branch: "main"), + .package(url: "https://github.com/apple/swift-docc-plugin", from: "1.0.0"), ], targets: [ // targets @@ -20,8 +20,6 @@ let package = Package( ``` > Important: Swift 5.6 is required in order to run the plugin. -> Development snapshots that include Swift 5.6 -> can be found on [Swift.org](https://www.swift.org/download/#snapshots). You can then invoke the plugin from the root of your repository like so: diff --git a/Sources/SwiftDocCPluginDocumentation/SwiftDocCPlugin.docc/SwiftDocCPlugin.md b/Sources/SwiftDocCPluginDocumentation/SwiftDocCPlugin.docc/SwiftDocCPlugin.md index 553491a..e170f93 100644 --- a/Sources/SwiftDocCPluginDocumentation/SwiftDocCPlugin.docc/SwiftDocCPlugin.md +++ b/Sources/SwiftDocCPluginDocumentation/SwiftDocCPlugin.docc/SwiftDocCPlugin.md @@ -7,12 +7,6 @@ Produce Swift-DocC documentation for Swift Package libraries and executables. The Swift-DocC plugin is a Swift Package Manager command plugin that supports building documentation for SwiftPM libraries and executables. -> Important: The Swift-DocC plugin is under **active-development** and is not ready for production -> use. -> -> We anticipate releasing a `1.0` version of the Swift-DocC plugin aligned with -> the release of Swift `5.6`. - After adding the plugin as a dependency in your Swift package manifest, you can build documentation for the libraries and executables in that package and its dependencies by running the following from the command-line: