Since we released VS Code, we have worked hard to have a great set of docs to help you get started.
We think of the docs as a core part of the product. We build them with VS Code as a set of Markdown files. We then use a Gulp task to transform them into HTML for our website (we actually provide some examples of how to do this in the Docs 🙂 ).
Since our initial launch, we have tried to improve the docs every release. For example, we have added in…
- A summary of what’s changed for each update – as well as updating the core docs as required
- An FAQ covering any known issues – we try to update this as they come in
- Site search to aid in discovery of content – the easiest way to find the missing setting
- Facebook and Twitter links – to help drive awareness of content
- Ability to send us doc feedback – which we review each day
- Increased our focus on languages and runtimes – with walk troughs for the most common ones
At the same time, we have witnessed many of our insiders and the community at large create additions and enhancements as well as fill in the gaps in our docs. A good example of this is the number of Unity & VS Code blogs, videos and projects that are out there. So… Today we moved the source files for our Docs to a GitHub repo.
The goal here is to work with the community (yes you reading this 🙂 ) to make them even better.
We had two new contributions from the community as we moved these over:
- Developing Unity Projects with VS Code – this also includes a community driven VS Code Unity plug-in
- Developing Office Add-ins with VS Code – including a ‘Yo Office‘ generator for VS Code
We would love your help to keep on evolving these new docs as well as our existing ones. We also plan to add an ‘Edit on GitHub’ link as well as a contributor list on the site. But that’s a job for another day.
Let us know what you think – or even better start contributing to the docs.
Sean McBreen – VS Code Team Member