docs migration - Configuring VS Code for Swift Development
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 28
- Forks
- 5
- Avg merge
- 18h 33m
- Merged PRs (30d)
- 18
Description
Source: documentation/articles/getting-started-with-vscode-swift.md
Proposed disposition: Migrate
Proposed destination: ecosystem-tools/Sources/EcosystemTools.docc/getting-started-with-vscode-swift.md
Reviewer: @swiftlang/ecosystem-steering-group
Checklist
- Create a GitHub issue to track this migration
- Determine disposition (suggested: Migrate) and confirm destination
- Review source for accuracy against the current VS Code Swift extension release
- Translate Jekyll markdown to DocC markdown format
- Remove YAML front matter
- Convert any Jekyll callouts to DocC-style callouts
- Update links (LSP docs, extension marketplace, etc.) to current URLs
- Verify code blocks and command examples against current toolchain
- Add article to
EcosystemTools.docc/Documentation.mdunder an "Editor Configuration" topic group - Run
swift package generate-documentation --analyze --warnings-as-errorsinecosystem-tools/ - Preview locally with
swift package --disable-sandbox preview-documentationinecosystem-tools/ - Submit PR to this repository for ecosystem 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
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 with documentation/articles/getting-started-with-vscode-swift.md, then migrate it to ecosystem-tools/Sources/EcosystemTools.docc/getting-started-with-vscode-swift.md and add it to EcosystemTools.docc/Documentation.md under an Editor Configuration topic group. Review the VS Code Swift extension details, links, code blocks, and command examples, then run the listed documentation analysis and preview commands. Done means the DocC article is validated and ready for ecosystem steering group review.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- swift, vscode
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 58/100