Skip to content

docs migration - Getting Started with Swift SDKs for WebAssembly #69

Description

@heckj

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.docc catalog for this content. If WebAssembly documentation grows substantially, consider splitting it into its own package in this repository. For the initial migration, EcosystemTools.docc is 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 build invocations 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.md under a "Platform Targets" topic group (or to a new WASM.docc Documentation.md if the standalone catalog path is chosen)
  • Run swift package generate-documentation --analyze --warnings-as-errors in 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

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    content migrationContent originally housed in the swift.org under /documentation/articles

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions