December Doc-a-thon

[gregvanl]

The goal is to identify missing, stale or obsolete content in the main VS Code docs.

You can:

1. Enter a vscode-docs issue describing the necessary change or addition.
2. Enter an issue and point to relevant existing content to port (release notes, issue comment, protocol or sample repo content).
3. Create or update content and submit a PR against vscode-docs master.

Topics

---

@gregvanl New topics that need a home:

• deferred Keyboard Layouts @alexandrudima
• Extensions that are only available to insiders @joaomoreno
• Extension Authoring>Extension Packs @sandy081
• Recommended Extensions @sandy081
• Customization>File icons @aeschli
• Hot Exit @Tyriar
• Promote Go to the same level as other languages in the docs, PHP, Python etc. @ramya-rao-a
• (initial progress) Editor Architecture @rebornix

---

Setup

• Overview @chrmarti
• Windows @ramya-rao-a
• Mac @chrmarti
• Linux @Tyriar
• Additional Components @chrmarti

Editor

• The Basics
  • @rebornix
  • @chrmarti
• Extension Marketplace @joaomoreno
• IntelliSense
  • @mjbvz
  • @waderyan vscode-docs #742
• Editing Evolved
  • @alexandrudima
  • @ramya-rao-a
• Debugging
  • @weinand
  • @isidorn
  • @roblourens
• Version Control @joaomoreno
• Tasks @dbaeumer
• Integrated Terminal@Tyriar
• Tabs @bpasero
• Accessibility
  • @alexandrudima
  • @rebornix
• Why VS Code @mousetraps

Customization

• Overview @sandy081
• User and Workspace Settings @sandy081
• Key Bindings @alexandrudima
• Snippets @jrieken
• Colorizer @aeschli
• Themes @aeschli
• Display Language
  • @dbaeumer
  • @ramya-rao-a

Languages

• Overview @ramya-rao-a
• JavaScript (including the jsconfig.json) section
  • @waderyan vscode-docs #740
  • @mjbvz
  • @egamma
• JSON @aeschli
• HTML @aeschli
• PHP @mousetraps
• Python @waderyan vscode-docs #739
• Markdown @mjbvz
• TypeScript
  • @dbaeumer
  • @mjbvz
• CSS, Sass, and Less @aeschli
• Dockerfile @chrisdias

Runtimes

• Node.js
  • @chrisdias
  • @egamma

Extension Authoring

• Overview @rebornix
• Example - Hello World @alexandrudima
• Example - Word Count @alexandrudima
• Example - Language Server @dbaeumer
• Example - Debuggers
  • @weinand
  • @roblourens
• Principles and Patterns
  • @jrieken
  • @rebornix
• Language Extension Guidelines
  • @dbaeumer
  • @jrieken
  • @aeschli
• Running and Debugging Extensions @bpasero
• Installing Extensions @joaomoreno
• Testing Extensions @bpasero
• Our Approach @rebornix

Extensibility Reference

• Overview @rebornix
• Extension Manifest @joaomoreno
• Contribution Points @jrieken
• Activation Events @jrieken
• API debugging
  • @weinand

Tools

• Publishing Tool @joaomoreno
• Extension Generator
  • @aeschli
  • @chrmarti
• Samples @ramya-rao-a

GitHub

• Tips and Tricks Repo @waderyan vscode-docs #743

[dbaeumer]

We have quite some satellite npm modules which maintain documentation as well. We should include this in a doc-a-thon. Mine are:

vscode-languageserver-node: https://github.com/Microsoft/vscode-languageserver-node
language-server-protocol: https://github.com/Microsoft/language-server-protocol
vscode-nls: https://github.com/Microsoft/vscode-nls
vscode-nls-dev: https://github.com/Microsoft/vscode-nls-dev

[dbaeumer]

@gregvanl for Language Extension Guidelines I added @aeschli and @jrieken as well. I can perfectly handle the LSP part in there but the other parts are better handled by @aeschli and @jrieken.

[aeschli]

@gregvanl File icons are already documented on the themes page. The content is still up-to-date

[sandy081]

@gregvanl Here is the PR for updating user and workspace settings documentation

#749

[dbaeumer]

Created PR: #760

[aeschli]

I've checked off all my items (just in case they uncheck themselves again).

Also I added a new sample: language provider sample, that brings the existing language server example to the extension sample projects. I improved the structure and added a compound launch config (launch client and attach server).
Please feel free to improve further. I'm off until after XMas. Happy holidays!

[joaomoreno]

I've checked off all my items (just in case they uncheck themselves again).

[chrisdias]

docker and node done!