swiftlang / swiftlang/docs

docs migration - Wrapping C/C++ Libraries in Swift

Open
#46 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/wrapping-c-cpp-library-in-swift.md
Proposed disposition: Needs determination (pending coordination with C++ interop team)
Proposed destination: language-guides/Sources/LanguageGuides.docc/wrapping-c-cpp-library-in-swift.md
Reviewer: @swiftlang/language-steering-group

Note: The proposal notes that Doug Gregor expressed a desire to reset and migrate the broader C/C++ interop content into the Swift repository. Coordinate before or during this migration to avoid duplicating effort. This article may move to a dedicated interop catalog if one is created.

Checklist

  • Create a GitHub issue to track this migration
  • Determine disposition (suggested: Migrate, pending interop team coordination) and confirm destination
  • Check with Doug Gregor / C++ interop team on plans for interop documentation
  • Review source for accuracy against current SwiftPM and CMake integration patterns
  • Translate Jekyll markdown to DocC markdown format
    • Remove YAML front matter
    • Convert any Jekyll callouts to DocC-style callouts
    • Verify SwiftPM and CMake examples are current
    • Verify module map examples reflect current toolchain behavior
    • Update any C++ interop sections against current Swift C++ interop status
  • Add article to LanguageGuides.docc/Documentation.md under an "Interoperability" topic group
  • Run swift package generate-documentation --analyze --warnings-as-errors in language-guides/
  • Preview locally with swift package --disable-sandbox preview-documentation in language-guides/
  • Submit PR to this repository for language 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 by reviewing documentation/articles/wrapping-c-cpp-library-in-swift.md and coordinating with the C++ interop team to confirm the disposition and destination. Translate the article into language-guides/Sources/LanguageGuides.docc/wrapping-c-cpp-library-in-swift.md, update the listed SwiftPM, CMake, module map, and interop content, and add it to Documentation.md. Run the two listed language-guides documentation commands; done includes steering-group review and the follow-up redirects.

Written by the indexing model from the issue text.

Assessment

Tech stack
c, cpp, swift
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.