Skip to content

Eliminate duplicate instructions? #288

@KimTheLearner

Description

@KimTheLearner

This is a concern regarding the Swift installation procedure. Below, after describing the issue, I have a request to change Swift - Getting Started and/or Download. I am new at Swift, and other thoughts are welcome! And many thanks to all who helped bring Swift to Windows!!! :)

Environment

build number: Swift 5.6.1
OS: Windows 10 desktop computer

Feature Description

Would it be possible to eliminate some duplicated instructions?

The complete install instructions are currently on both Swift - Getting Started and Download. It would seem wiser to store the instructions in only one place. Could one of these pages be the sole location and the other simply link to that?

Rationale: I am in the process of submitting a number of change requests to the installation procedure on these documentation pages, so this suggestion will have two benefits: 1) it will be less maintenance, and 2) it just keeps them from getting out of sync (the DRY principle).

Suggested Documentation Fixes

At the top of Swift - Getting Started,
change this:
The first step to using Swift is to download and install the compiler and other required components. Go to the Download page and follow the instructions for your target platform.

to this:
The first step to using Swift is to download and install the compiler and other required components. Go to the Download page to download the release of your choice, then follow the instructions below for your target platform.

Or, if you prefer, you could flip that and keep the instructions only on Download.

Also, while problem solving my install, I was directed to a third set of instructions:

pwsacademy swift-setup

by the page When I install swift correctly....

Would you consider merging any valuable install information on that first page into the official install instructions page? Especially the "Known Issues".

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions