swiftlang / swiftlang/docs

Add doc on porting code to non-Apple platforms

Open
#21 5 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

I wanted to add a documentation page showing common patterns in porting Swift packages to Android, then @compnerd pointed out that we have no such doc for any platform now. Since all non-Apple platforms will need similar changes, like adding the relevant overlay imports, along with a few platform-unique needs, perhaps we can put together a single doc page for all these new platforms.

@Joannis, @al45tair, @kateinoigakukun, @marcprux, let me know what you think about collaborating on such porting doc, including platform-specific info for linux servers, Musl, Wasm, and Android. I think this would help us move cross-platform compatibility up from the 20-40% currently reported on the package index.

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

The issue does not name specific files or tests. Start by reviewing the existing documentation structure and gathering the common porting patterns plus platform-specific requirements for Linux servers, Musl, Wasm, and Android. Done means one consolidated page covering overlay imports and the relevant platform differences.

Written by the indexing model from the issue text.

Assessment

Tech stack
android, linux, swift, wasm
Domain
documentation, mobile-dev, operating-systems
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.