docs migration - Standard Library
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 28
- Forks
- 5
- Avg merge
- 18h 33m
- Merged PRs (30d)
- 18
Description
Source: documentation/standard-library/index.md
Proposed disposition: Needs determination — this page provides a brief overview and links to Apple Developer documentation and stdlib design content (via _preview-package.md and _stdlib-design.md includes). The standard library content is being updated to be generated as its own separate catalog, and when that's available, redirect this content to that hosted location.
Reviewer: @swiftlang/language-steering-group
Note: The
_preview-package.mdand_stdlib-design.mdinclude files are incorporated into this page and should be handled as part of the same decision.
Checklist
- Create a GitHub issue to track this migration once destination is confirmed (if migrating)
- Determine disposition and choose explicit destination
- Decide how to handle
_preview-package.mdand_stdlib-design.mdinclude content - If migrating: translate Jekyll markdown to DocC markdown format
- Remove YAML front matter
- Inline content from include files or create separate articles
- Convert any Jekyll callouts to DocC-style callouts
- Verify links to Apple Developer documentation and Swift Package Index are current
- If migrating: add article(s) to target catalog's
Documentation.md - Run
swift package generate-documentation --analyze --warnings-as-errorsin 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
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading documentation/standard-library/index.md together with the _preview-package.md and _stdlib-design.md includes, then determine the explicit destination with the language steering group. If migration is approved, follow the listed DocC conversion steps, add the articles to the target catalog's Documentation.md, and run the specified generation and preview commands. Done means the destination and include handling are decided, the catalog is published, and the source page has a redirect_to entry.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown, swift
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100