swiftlang / swiftlang/docs

docs migration - Getting Started with Swift SDKs for WebAssembly

Open
#69 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

content migration
Dominant language
Python
Stars
28
Forks
5
Avg merge
18h 33m
Merged PRs (30d)
18

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.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

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with documentation/articles/wasm-getting-started.md and compare its instructions with the Swift 6.2 Wasm SDK release. Migrate the content to ecosystem-tools/Sources/EcosystemTools.docc/wasm-getting-started.md, update EcosystemTools.docc/Documentation.md, and run the listed documentation generation and preview commands. Done means the article is accurate, DocC-compatible, locally previewable, and ready for steering group review.

Written by the indexing model from the issue text.

Assessment

Tech stack
swift, wasm
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.