Skip to content

Convert docs to DocC #1437

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 1, 2025
Merged

Convert docs to DocC #1437

merged 1 commit into from
Apr 1, 2025

Conversation

daveyc123
Copy link
Contributor

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

@daveyc123
Copy link
Contributor Author

First rough pass at this. Looking for initial feedback before proceeding.

Copy link
Member

@matthewbastien matthewbastien left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks awesome! Just a few minor comments.


> Warning: DocC Preview is only supported with Swift toolchains versioned 6.2 or higher

Docs here!
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess I'll have to fill this in later, huh? 😜

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yup :) Free free to add something to this PR

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can remove this document for now since the DocC feature isn't ready yet. I'll put up a separate PR to add it later.

@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:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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.

@daveyc123 daveyc123 force-pushed the betterDocs branch 2 times, most recently from 42d6c6a to 28cdd14 Compare March 25, 2025 23:40
@daveyc123
Copy link
Contributor Author

Thanks for the feedback @heckj. I've addressed your feedback and rebased the PR.


> Warning: DocC Preview is only supported with Swift toolchains versioned 6.2 or higher

Docs here!
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can remove this document for now since the DocC feature isn't ready yet. I'll put up a separate PR to add it later.

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
@matthewbastien matthewbastien merged commit 38db866 into swiftlang:main Apr 1, 2025
12 of 14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants