From the embedded page, link to the tools page to set up editors #740
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
ahoppen
requested review from
0xTim,
alexandersandberg,
daveverwer,
dempseyatgithub,
parispittman,
kaishin,
shahmishal,
timsneath and
federicobucchi
as code owners
| @@ -215,7 +215,7 @@ Hooray! Our first *host-side* Embedded Swift program is working! | |||
| - The [Embedded Swift Vision Document](https://github.com/swiftlang/swift-evolution/blob/main/visions/embedded-swift.md) will give you an overview of the approaches and goals of Embedded Swift, and also what exactly is in the Embedded Swift language subset. | |||
| - The [collection of Embedded Swift example projects](https://github.com/apple/swift-embedded-examples) on GitHub shows on which embedded devices can Swift work today, and the examples can also be used as templates for your own projects. | |||
| - The [Embedded Swift User Manual](https://github.com/apple/swift/blob/main/docs/EmbeddedSwift/UserManual.md) describes how to use the Embedded Swift compilation mode and how to interact with the compiler. | |||
| - You might want to set up [Swift editor integration via SourceKit-LSP](https://github.com/swiftlang/sourcekit-lsp) to get features like indexing, autocomplete, jump-to-definition, show declarations/documentations, etc. to work in your favorite editor or IDE. | |||
| - To set up Swift integration in your editor, read one of our [setup guides](https://www.swift.org/tools/). | |||
There was a problem hiding this comment.
Suggested change
| - To set up Swift integration in your editor, read one of our [setup guides](https://www.swift.org/tools/). | |
| - The [Tools page](https://www.swift.org/tools/) has guides for setting up Swift integration in your editor to enable features like indexing, autocomplete, jump-to-definition, and others. |
All the other bullet points in the list start with the name of the resource being recommended. This suggestion matches the style of the other bullet points and preserves a shortened version of the benefit to the reader of following the link.
There was a problem hiding this comment.
Maybe also include the #editors anchor?
There was a problem hiding this comment.
Good suggestion. Thanks!
ahoppen
force-pushed
the
embedded-editor-using-tools-page
branch
from
e8999cd
to
b995038
Compare
|
@swift-ci test |
dempseyatgithub
approved these changes
Jun 27, 2024
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.
No description provided.