Skip to content

Conversation

@daveverwer
Copy link
Contributor

Motivation:

Improving the Getting Started page from the perspective of someone completely new to Swift.

Modifications:

  • Removed the references to swift build, swift test, swift run. If someone had just installed Swift to the point where they can run swift --version as recommended on the lines above, these commands are going to fail while looking for Package.swift. The use case examples below introduce these commands in a more natural way.
  • Tweaked how we introduce the SwiftPM abbreviation when we first introduce it (and also on the package manager page).
  • Link to the package manager page when introducing SwiftPM.
  • Added a link to TSPL. I know we want to get into some slightly less daunting tasks than "Read this whole book", but I feel it's important to have a link to it somewhere on this page. I tried to phrase it as optional.

Copy link
Member

@alexandersandberg alexandersandberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great!

@daveverwer
Copy link
Contributor Author

daveverwer commented Jan 19, 2023

@swift-ci please test

I'm not sure what exactly this is going to test as it's not being merged into main yet and it'll all get a test when that merge finally happens, but I figure it's better safe than sorry!

Edit: Looks like no testing on non-default branches... 👍

@daveverwer daveverwer merged commit 5cc68a3 into swiftlang:content-improvements Jan 19, 2023
@daveverwer daveverwer deleted the getting-started-swiftpm-tweaks branch February 13, 2023 17:14
kaishin added a commit that referenced this pull request Sep 7, 2023
* Update landing page content (#127)
* First pass at the new Getting Started page (#174)
* Adding Getting Started tutorial for SwiftUI / iOS 16. (#185)
* Add data file with items for "Go Further" section (#184)
* Add cli and library getting started guides (#192)
* Getting started tweaks (#208)
* Rename Markdown files to have an `.md` extension. (#209)
* Fix typo (#214)
* Update getting started page layout (#204)
* Add documentation information to Getting Started (#226)
* Add Vapor Getting Started guide (#229)
* Update content-improvments branch per feedback (#244)
* Tweak SwiftUI tutorial (#240)
* Add TSPL Go Further section and resource thumbnails (#227)
* Improve 'Why Swift?' section on landing page (#252)
* Replace Go Further item for advanced String Under The Hood blog post with item for Structures and Classes chapter in TSPL (#254)
* Update landing page layout (#267)
* Link to developer.apple.com from apple use case (#291)
* Smaller landing page changes on content improvements branch (#294)
* Update Go Further section (#300)
* Update icons and placeholder image (#301)
* Improve description of use cases and getting started guides (#304)
* POC: Feature random code snippet on landing page (#303)
* New “Swift is…” and About page copy (#336)
* Move link to A Swift Tour to the Use Cases section (#329)
* Add consistent download section to start and end of each guide (#351)
* Add a new install page, update the download page, and move release yml files into one file. (#310)
* Update navigation for install page (#355)
* Update cli and library getting started guides (#357)
* Content improvement guide updates (#373)
* Add value and reference types article (#377)
* Add some showcase snippets (#371)
* Resolve issue with Red Hat download links (#379)
* Add Info about Scoop for Windows install page (#382)

---------

Co-authored-by: Alexander Sandberg <[email protected]>
Co-authored-by: Paul Hudson <[email protected]>
Co-authored-by: James Dempsey <[email protected]>
Co-authored-by: tomer doron <[email protected]>
Co-authored-by: Dave Verwer <[email protected]>
Co-authored-by: Tim Condon <[email protected]>
Co-authored-by: Max Desiatov <[email protected]>
Co-authored-by: Mishal Shah <[email protected]>
Co-authored-by: AG <[email protected]>
Co-authored-by: Ted Kremenek <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants