swiftlang / swiftlang/docs

Safely Mixing Swift and C/C++

Open
#51 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/cxx-interop/safe-interop/index.md
Proposed disposition: Needs determination — defer to C++ interop team (same group as Mixing Swift and C++)
Reviewer: @swiftlang/language-steering-group

Checklist

  • Create a GitHub issue to track this migration once destination is confirmed
  • Determine disposition alongside cxx-interop/index.md (same destination decision)
  • Review source for accuracy against current Swift memory safety annotations for C++ interop
  • Translate Jekyll markdown to DocC markdown format
    • Remove YAML front matter
    • Convert any Jekyll callouts to DocC-style callouts
    • Verify safety annotation examples compile under current toolchain
  • Add article to target catalog's Documentation.md
  • Run swift package generate-documentation --analyze --warnings-as-errors in the target package
  • Preview locally with swift package --disable-sandbox preview-documentation
  • Submit PR for appropriate team 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/cxx-interop/safe-interop/index.md and compare its destination decision with cxx-interop/index.md, deferring the choice to the C++ interop team. Review the current memory-safety annotation examples, then translate the Jekyll markdown, update the target Documentation.md catalog, and run the listed documentation generation and preview commands. Done means the article is reviewed, published, and the source file receives its redirect_to: update.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp, swift
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.