swiftlang / swiftlang/docs

Supported Features and Constraints of C++ Interoperability

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

Note: This is a status/reference page that will need frequent updates as interop support evolves. Consider whether it belongs in a DocC catalog or is better maintained as a living document closer to the compiler source.

Checklist

  • Create a GitHub issue to track this migration once destination is confirmed
  • Determine disposition alongside cxx-interop/index.md (same destination decision)
  • Evaluate whether a frequently-updated status page is better served in a DocC catalog or as a reference page maintained alongside the compiler
  • Review source for completeness against current C++ interop feature set
  • Translate Jekyll markdown to DocC markdown format (if migrating to DocC)
    • Remove YAML front matter
    • Reorganize as a structured reference article with clear sections per C++ feature category
  • 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/status/index.md and compare the related cxx-interop/index.md issue. First determine the destination and maintenance approach with the C++ interop team, then review the page against the current feature set and follow the migration checklist. Done means the destination is agreed, the article is migrated and cataloged if applicable, validation and preview pass, and redirects are submitted after publication.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp, swift
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.