Update documentation for swiftly #1905
Conversation
matthewbastien
requested review from
0xTim,
adam-fowler and
award999
as code owners
Co-authored-by: Paul LeMarquand <plemarquand@gmail.com>
heckj
left a comment
heckj
left a comment
There was a problem hiding this comment.
some wording tweaks and suggestions - mostly tightening the wording and switching to a more direct wording, using present tense.
Co-authored-by: Joseph Heck <j_heck@apple.com>
rbenegal
left a comment
rbenegal
left a comment
There was a problem hiding this comment.
Looks good to me, thanks! Just some minor suggestions.
| ## Swiftly Support | ||
|
|
||
| The extension supports toolchains managed by [swiftly](https://github.com/swiftlang/swiftly), the Swift toolchain installer and manager. For instructions on installing swiftly see the [installation instructions on Swift.org](https://www.swift.org/install). | ||
| The extension supports toolchains managed by [swiftly](https://github.com/swiftlang/swiftly), the Swift toolchain installer and manager. This is the recommended way of installing Swift toolchains on macOS and Linux. For instructions on installing swiftly see the [installation instructions on Swift.org](https://www.swift.org/install). |
There was a problem hiding this comment.
Would it be better to use swiftly (in monospace font) instead of just swiftly everywhere to make sure people understand that we're referring to the tool and not the adverb?
There was a problem hiding this comment.
I'm on the fence about this one. Swiftly's documentation always refers to itself as swiftly without the monospace and all lower-case (even when it's at the start of a sentence which is interesting). I also don't think that the monospaced font is super distinguishable between the standard font in the compiled documentation unless it's made bold as well.
|
Azure outage is making it so that we can't download VS Code to run tests. Merging despite the one build failure. |
5 participants
Description
Add swiftly installation and toolchain selection commands to documentation.
Tasks
[ ] Required tests have been written[ ] Added an entry to CHANGELOG.md if applicable