swiftlang / swiftlang/docs

docs migration - Core Libraries

Open
#48 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/core-libraries/index.md
Proposed disposition: Needs determination — this page provides overview descriptions of Foundation, libdispatch, XCTest, and Swift Testing, each of which has its own repository and documentation. The _foundation.md, _libdispatch.md, _swift-testing.md, and _xctest.md include files are consumed by this page and should be dealt with together.
Reviewer: Foundation team, libdispatch team, XCTest team, and Swift Testing team — one sign-off per library section

Checklist

  • Determine disposition (suggested: Deprecate) and confirm redirect target for each library
  • Identify current canonical documentation URLs for Foundation, libdispatch, XCTest, and Swift Testing
  • Add redirect_to: to the swift.org source file's front matter (to best single landing page, or update the page to be a plain links page)
  • Remove or archive the four include files once the redirect is in place
  • 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/core-libraries/index.md and its _foundation.md, _libdispatch.md, _swift-testing.md, and _xctest.md includes. Determine the disposition and canonical documentation URL for each library, then review the source front matter and redirect approach. Done means the redirect or links-page decision is recorded, obsolete includes are removed or archived, and the redirect PR is submitted to swift-org-website.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.