Skip to content
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

Documentation for the Swift extension for VS Code #1121

Open
matthewbastien opened this issue Oct 3, 2024 · 1 comment
Open

Documentation for the Swift extension for VS Code #1121

matthewbastien opened this issue Oct 3, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@matthewbastien
Copy link
Member

Currently, there are two locations for documentation about how to use the Swift extension for Visual Studio Code:

  1. A page on https://www.swift.org/tools/ which outlines how to install the extension and has sections for the most commonly used features
  2. A folder within this repository that goes over a few features and contains documentation for contributors. Right now this is very bare-bones and does not cover a whole lot of features.

Microsoft also has a documentation page giving overviews of features for various languages that can be contributed to by the community in the VS Code documentation repository. This could be a great place to contribute to as well.

Investigate options for making contributions to these various sources and try to make documentation easier to find for users of the Swift extension for VS Code. It should also be as simple as possible to contribute to these various sources for contributors to the extension.

@matthewbastien
Copy link
Member Author

Putting in my two cents: I've seen other Swift repositories using swift-docc to generate documentation from markdown. This is then compiled into a single page web application that can be published as a GitHub webpage which could be a valid replacement for the simple markdown content that exists for the extension right now.

@award999 award999 added documentation Improvements or additions to documentation and removed enhancement New feature or request labels Oct 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Development

No branches or pull requests

2 participants