-
Notifications
You must be signed in to change notification settings - Fork 1
docs migration - Getting Started with Swift SDKs for WebAssembly #69
Copy link
Copy link
Open
Labels
content migrationContent originally housed in the swift.org under /documentation/articlesContent originally housed in the swift.org under /documentation/articles
Description
Source: documentation/articles/wasm-getting-started.md
Proposed disposition: Migrate
Proposed destination: ecosystem-tools/Sources/EcosystemTools.docc/wasm-getting-started.md
Reviewer: @swiftlang/ecosystem-steering-group
Note: The proposal sketched a separate
ecosystem/WASM.docccatalog for this content. If WebAssembly documentation grows substantially, consider splitting it into its own package in this repository. For the initial migration,EcosystemTools.doccis the right fit.
Checklist
- Create a GitHub issue to track this migration
- Determine disposition (suggested: Migrate) and confirm destination; assess whether a standalone WASM catalog is warranted at this time
- Review source for accuracy against the Swift 6.2 Wasm SDK release
- Translate Jekyll markdown to DocC markdown format
- Remove YAML front matter
- Convert any Jekyll callouts to DocC-style callouts
- Verify SDK installation steps and
swift buildinvocations for Wasm targets - Confirm Embedded Swift section reflects current capabilities
- Update editor configuration references to link to the VS Code, Emacs, and Neovim articles in this catalog
- Add article to
EcosystemTools.docc/Documentation.mdunder a "Platform Targets" topic group (or to a newWASM.doccDocumentation.mdif the standalone catalog path is chosen) - Run
swift package generate-documentation --analyze --warnings-as-errorsin the target package - Preview locally with
swift package --disable-sandbox preview-documentation - Submit PR to this repository for ecosystem steering group review
- After merge and publication: add
redirect_to:in the swift.org source file's front matter - Submit redirect PR to swift-org-website
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
content migrationContent originally housed in the swift.org under /documentation/articlesContent originally housed in the swift.org under /documentation/articles