Lightly edited existing content and added new information as suggested. #650
Conversation
RobinBateman808
requested review from
0xTim,
alexandersandberg,
daveverwer,
dempseyatgithub,
parispittman,
kaishin,
shahmishal,
cthielen and
federicobucchi
as code owners
|
@shahmishal @federicobucchi - Here are the suggested changes as requested. Feel free to make changes for accuracy. Thanks! |
install/macos/index.md
Outdated
|
|
||
| **Docker and Swift images** - You can run Swift applications within [Docker containers](https://www.swift.org/install/linux/) using [Swift Docker images](https://hub.docker.com/_/swift/). Docker provides a way to package, distribute, and run Swift applications consistently across different environments. | ||
|
|
||
| ## Build your first app |
There was a problem hiding this comment.
This section seems a bit redundant on the install on macOS page - why not just link out to https://www.swift.org/getting-started/
There was a problem hiding this comment.
Hi @0xTim - Agreed. The additional section/information aims to provide basic instructions to help beginners get started through a 1, 2, 3 step-by-step approach, while linking to the same content referenced from the Getting Started page. It also includes brief descriptions (and links) to "basic" tutorials (e.g. getting started w/Xcode), serving as an additional reference point to useful (existing) content. This can be helpful since user behavior varies. That help?
install/macos/index.md
Outdated
|
|
||
| Basic configuration steps are essential for setting up your development environment, ensuring proper project structure, and preparing your workflow for smooth app development. | ||
|
|
||
| 1. Set up your workspace: Create a new folder for your project or open an existing Swift project folder in Visual Studio Code. |
There was a problem hiding this comment.
We should have the sections about VScode, the extension and Xcode before this section
There was a problem hiding this comment.
@0xTim - Added anchors to the basic config section to jump to each subsection (i.e. VSCode, Swift REPL) to maintain the flow of information and mitigate confusion for beginners.
|
@shahmishal - See the scope/suggested changes. Thank you! |
@shahmishal - removed install on macOS instructions and added lead-in sentences to Install via Xcode and Install via package installer to provide more context for beginners.
|
|
||
| The macOS `.pkg` files are digitally signed | ||
| by the developer ID of the Swift open source project | ||
| by the developer ID of the Swift open-source project |
There was a problem hiding this comment.
cc @cthielen for open source vs open-source
|
@shahmishal, @cthielen - Any decision on the "open source" versus "open-source" format? According to style guide formatting, a hyphen is used when a noun precedes it. However, I will defer to common usage or other advisory. Thanks! |
Motivation:
Help developers and beginners start using Swift.
Modifications:
Lightly edited existing content and added new information and instructions.
Result:
Increase Swift user adoption.