Content improvements #354
Merged
Content improvements #354
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Co-authored-by: Alexander Sandberg <hi@alexandersandberg.com>
* Adding Getting Started tutorial for SwiftUI / iOS 16. * Corrections from James and Reda. * Update getting-started/swiftui/index.md Co-authored-by: Alexander Sandberg <hi@alexandersandberg.com>
* Add data file with items for "Go Further" section * Make thumbnail-url values null with a TBD comment * Add missing sentence from Swift strings entry
motivation: getting started guides changes: * add a cli guide * add a library guide + link from index page * share install instructions across pages
* Tweaked the very start of the new Getting Started page. * Added a link to TSPL in case people want to get started with that type of resource. * Linked to the package manager page. * Introduced SwiftPM on the package manager page, too.
* add documentation section to getting started * remove absolute path from go further resource url * merge documentation section into other sections * update sidebar navigation * rewrite tspl paragraph
* Add Vapor Getting Started guide * Add link to Codable * Update getting-started/vapor-web-server/index.md Co-authored-by: Max Desiatov <m_desiatov@apple.com> * Code review comments --------- Co-authored-by: Max Desiatov <m_desiatov@apple.com>
motivation: address feedback from content review changes: * slight langauge changes * update vapor guide to be more generic so that we an also point to other web frameworks in the future Co-authored-by: Tim Condon <0xTim@users.noreply.github.com>
* Format Swift code correctly * Add images * Add link to tutorial * Update images and use video instead of gif --------- Co-authored-by: Reda Lemeden <git@redalemeden.com>
…with item for Structures and Classes chapter in TSPL (#254)
Co-authored-by: Alexander Sandberg <hi@alexandersandberg.com>
* fix letter casing on landing page * update latest release to 5.8 on landing page
- Use latest URL for Swift tour in TSPL - Reorder items - Add title and blurb for Value and Reference Types blog post
motivation: address feedback from core-team changes: * improve description of landing page use cases * improve description of getting started guides * add "cross platform command-line tool" as a landing page use case, link to getting started guides (TODO: come up with better) Co-authored-by: Alexander Sandberg <hi@alexandersandberg.com>
* fix latest release button smaller than rest when column * WIP: add featured snippets to landing page * ensure that snippet visibility rules are not overridden * formatting * remove important from css rules * add height to featured snippet to prevent layout shifts * move snippet to top of landing page * remove long snippet example
* New “Swift is…” copy. * Tweaked preamble wording. * Removed bolding from the About page. * Typo. * Whitespace. * Fixed up sentence in the About page. * More minor wording tweaks. * Removed extra space. * Suggestion from Reda on the quick and fast line.
tomerd
reviewed
Sep 6, 2023
tomerd
reviewed
Sep 6, 2023
cthielen
reviewed
Sep 6, 2023
tomerd
reviewed
Sep 6, 2023
tomerd
reviewed
Sep 6, 2023
tomerd
reviewed
Sep 6, 2023
Co-authored-by: tomer doron <tomer@apple.com>
Co-authored-by: tomer doron <tomer@apple.com>
tkremenek
approved these changes
Sep 7, 2023
stevapple
suggested changes
Sep 7, 2023
| #### Installation Instructions | ||
|
|
||
| ##### Install using the Windows Package Manager | ||
| ## Install using the Windows Package Manager | ||
|
|
||
| The [Windows Package Manager](https://docs.microsoft.com/windows/package-manager/) can be found in the [Microsoft Store](https://www.microsoft.com/en-us/p/app-installer/9nblggh4nns1) or be [installed directly](ms-appinstaller:?source=https://aka.ms/getwinget). |
There was a problem hiding this comment.
Something we missed from the prior PR: WinGet is preinstalled on Windows 11 (21H2 and later) now.
Comment on lines
-126
to
-129
| * Using Scoop: | ||
| ~~~ cmd | ||
| scoop install swift | ||
| ~~~ |
|
|
||
| 1. Install Swift: | ||
| 0. Install Swift: | ||
|
|
||
| Swift can be installed through the official installer directly, or using the Windows Package Manager as well. Notice that Windows Package Manager release may be behind the official release. |
There was a problem hiding this comment.
Suggested change
| Swift can be installed through the official installer directly, or using the Windows Package Manager as well. Notice that Windows Package Manager release may be behind the official release. | |
| Swift can be installed through the official installer directly, or using supported package managers as well. Notice that latest release from the supported package managers may lag behind the official release. |
| @@ -110,8 +55,8 @@ Invoke-RestMethod -Url 'get.scoop.sh' | Invoke-Expression | |||
| ~~~ cmd | |||
| pip install six | |||
| ~~~ | |||
|
|
|||
| 1. Install Swift: | |||
|
|
|||
Comment on lines
-64
to
-67
| #### Enabling Developer Mode | ||
|
|
||
| In order to develop applications, particularly with the Swift Package Manager, you will need to enable developer mode. Please see Microsoft's [documentation](https://docs.microsoft.com/en-us/windows/apps/get-started/enable-your-device-for-development) for instructions for enabling developer mode. | ||
|
|
There was a problem hiding this comment.
Why is this dropped? Developer mode is still required for SwiftPM. It could be mentioned later, but definitely worth the attention.
stevapple
reviewed
Sep 7, 2023
| #### Installation Instructions | ||
|
|
||
| ##### Install using the Windows Package Manager | ||
| ## Install using the Windows Package Manager |
There was a problem hiding this comment.
The title should be updated to indicate both WinGet and Scoop. Perhaps a general “Install using package manager”?
In fact I think it may be worth splitting these two because now they’re mostly independent.
There was a problem hiding this comment.
@stevapple Would you be able to create a PR with suggested changes?
Tweak language on how Swift is good as a general-purpose programming language, focusing on "joy" instead of "quick to write." Co-authored-by: tomer doron <tomer@apple.com>
shahmishal
approved these changes
Sep 7, 2023
|
@swift-ci test |
|
🎊 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR aims to introduce the content changes that the SWWG have worked on since last year.
Several changes have been made to the content of the most visited pages of the website, including the landing page, the getting started page, and the install page.
The main changes are:
The PR can be previewed here.
Checklist
The following are steps that need to be taken before merging this PR.
main