Skip to content

docs migration - Configuring VS Code for Swift Development #66

Description

@heckj

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.md under an "Editor Configuration" topic group
  • Run swift package generate-documentation --analyze --warnings-as-errors in ecosystem-tools/
  • Preview locally with swift package --disable-sandbox preview-documentation in ecosystem-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

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    content migrationContent originally housed in the swift.org under /documentation/articles

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions