swiftlang / swiftlang/docs

docs migration - Value and Reference Types in Swift

Open
#45 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/value-and-reference-types.md
Proposed disposition: Migrate
Proposed destination: language-guides/Sources/LanguageGuides.docc/value-and-reference-types.md
Reviewer: @swiftlang/language-steering-group

Checklist

  • Create a GitHub issue to track this migration
  • Determine disposition (suggested: Migrate) and confirm destination
  • Review source for accuracy and alignment with Swift 6 (particularly the actor content)
  • Translate Jekyll markdown to DocC markdown format
    • Remove YAML front matter
    • Convert any Jekyll callouts to DocC-style callouts
    • Verify all code examples compile under Swift 6 strict concurrency
    • Update actor-related content to reflect Swift 6 concurrency model if needed
  • Add article to LanguageGuides.docc/Documentation.md under a "Fundamentals" or "Types" 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

The migration targets language-guides/Sources/LanguageGuides.docc/value-and-reference-types.md and the remaining checklist item concerns the Swift.org source file's front matter. First verify that the migration has merged and been published, then add the redirect_to entry and submit the redirect PR to swift-org-website. Done means the redirect change is submitted.

Written by the indexing model from the issue text.

Assessment

Tech stack
swift
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.