Convert docs to DocC #1437
Convert docs to DocC #1437
Conversation
|
First rough pass at this. Looking for initial feedback before proceeding. |
|
|
||
| > Warning: DocC Preview is only supported with Swift toolchains versioned 6.2 or higher | ||
|
|
||
| Docs here! |
There was a problem hiding this comment.
I guess I'll have to fill this in later, huh? 😜
There was a problem hiding this comment.
Yup :) Free free to add something to this PR
This change migrates the markdown based documentation into a DocC bundle with the goal to publish this documentation on swift.org. This change: * Adds a DocC bundle with the existing documentation * Pares down the readme to remove most of the documentation and links out to the documentation instead * Adds a command to the extension to open the documentation * Adds the open documentation command to the project view
| Language support for Swift in Visual Studio Code. | ||
|
|
||
| @Metadata { | ||
| @DisplayName("vscode-swift") |
There was a problem hiding this comment.
this might be better merged in under line 4, to keep the metadata directive elements grouped together.
| @DisplayName("vscode-swift") | ||
| } | ||
|
|
||
| This extension adds language support for Swift to Visual Studio Code, providing a seamless experience for developing Swift applications on all supported platforms. It supports: |
There was a problem hiding this comment.
| This extension adds language support for Swift to Visual Studio Code, providing a seamless experience for developing Swift applications on all supported platforms. It supports: | |
| This extension adds language support for Swift to Visual Studio Code, providing a seamless experience for developing Swift applications. It supports: |
Given that you can't really build iOS based apps (at least in my understanding) through VSCode, I'm not sure "all supported platforms" really fits.
|
|
||
| > Tip: Debugging works best when using a version of the Swift toolchain 6.0 or higher | ||
|
|
||
| > Tip: Debugging uses workflows common to all VSCode extensions. For more information see https://code.visualstudio.com/docs/editor/debugging |
There was a problem hiding this comment.
Two > Tip: in a row makes a pretty large footprint on the rendered page, and pushes the content just below way down. The second one of these I'm not even sure really rises to what I'd think of as a tip - it doesn't optimize anything or show you a smoother path - so I'd suggest moving the content about the fact that debugging uses the common VSCode extension workflow pieces to the end of this content, and use that as a wrapping up bit that provide a place to read for more general information.
(If there's something specific about the general workflows that's important to know when wanting to use debugging through VSCode, definitely call that out early - I'm guessing that this isn't the case here, and it's more of a "for more information..." bit for the curious)
This change migrates the markdown based documentation into a DocC bundle with the goal to publish this documentation on swift.org.
This change: