Skip to content

Commit

Permalink
squash!
Browse files Browse the repository at this point in the history
  • Loading branch information
NikolaRHristov committed Nov 17, 2023
1 parent f3594fb commit a386dfc
Show file tree
Hide file tree
Showing 296 changed files with 63,986 additions and 30,080 deletions.
209 changes: 131 additions & 78 deletions CONTRIBUTING.md

Large diffs are not rendered by default.

13 changes: 9 additions & 4 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
Copyright (c) Microsoft Corporation. All rights reserved. Distributed under the following terms:
Copyright (c) Microsoft Corporation. All rights reserved. Distributed under the
following terms:

1. Documentation is licensed under the [Creative Commons Attribution 3.0 United States License](https://creativecommons.org/licenses/by/3.0/us/legalcode). Code is licensed under the [MIT License](https://opensource.org/licenses/MIT).

2. This license does not grant you rights to use any trademarks or logos of Microsoft. For Microsoft’s general trademark guidelines, go to https://go.microsoft.com/fwlink/?LinkID=254653.
1. Documentation is licensed under the
[Creative Commons Attribution 3.0 United States License](https://creativecommons.org/licenses/by/3.0/us/legalcode).
Code is licensed under the
[MIT License](https://opensource.org/licenses/MIT).

2. This license does not grant you rights to use any trademarks or logos of
Microsoft. For Microsoft’s general trademark guidelines, go to
https://go.microsoft.com/fwlink/?LinkID=254653.
51 changes: 37 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,18 @@

# Visual Studio Code Documentation

You've found the Visual Studio Code documentation GitHub repository, which contains the content for the [Visual Studio Code documentation](https://code.visualstudio.com/docs).
You've found the Visual Studio Code documentation GitHub repository, which
contains the content for the
[Visual Studio Code documentation](https://code.visualstudio.com/docs).

Topics submitted here will be published to the [Visual Studio Code](https://code.visualstudio.com) portal.
Topics submitted here will be published to the
[Visual Studio Code](https://code.visualstudio.com) portal.

If you are looking for the VS Code product GitHub repository, you can find it [here](https://github.com/Microsoft/vscode).
If you are looking for the VS Code product GitHub repository, you can find it
[here](https://github.com/Microsoft/vscode).

## Index

1. [About Visual Studio Code](#visual-studio-code)
2. [Contributing to the documentation](#contributing-to-the-documentation)
3. [Feedback](#feedback)
Expand All @@ -20,47 +25,65 @@ If you are looking for the VS Code product GitHub repository, you can find it [h

## Visual Studio Code

[VS Code](https://code.visualstudio.com/) is a lightweight source code editor and powerful development environment for building and debugging modern web and cloud applications. It is free and available on your favorite platform - Linux, macOS, and Windows.
[VS Code](https://code.visualstudio.com/) is a lightweight source code editor
and powerful development environment for building and debugging modern web and
cloud applications. It is free and available on your favorite platform - Linux,
macOS, and Windows.

If you landed here looking for other information about VS Code, head over to [our website](https://code.visualstudio.com) for additional information.
If you landed here looking for other information about VS Code, head over to
[our website](https://code.visualstudio.com) for additional information.

## Contributing to the documentation

To contribute with new topics/information or make changes to existing documentation, see [contributing](https://github.com/Microsoft/vscode-docs/blob/master/CONTRIBUTING.md#contributing) for instructions and guidelines.
To contribute with new topics/information or make changes to existing
documentation, see
[contributing](https://github.com/Microsoft/vscode-docs/blob/master/CONTRIBUTING.md#contributing)
for instructions and guidelines.

## Feedback

If you want to give documentation feedback, please use the feedback control located at the bottom of each documentation page.
If you want to give documentation feedback, please use the feedback control
located at the bottom of each documentation page.

## Documentation Issues

To enter documentation bugs, please create a [new GitHub issue](https://github.com/Microsoft/vscode-docs/issues) (try to check if there isn't a topic about your issue already).
To enter documentation bugs, please create a
[new GitHub issue](https://github.com/Microsoft/vscode-docs/issues) (try to
check if there isn't a topic about your issue already).

If you think the issue is with the VS Code product itself, please enter issues [here](https://github.com/Microsoft/vscode/issues).
If you think the issue is with the VS Code product itself, please enter issues
[here](https://github.com/Microsoft/vscode/issues).

## Editing

In order to edit the VS Code documentation, ensure that you have [Git](https://git-scm.com/downloads) installed.
In order to edit the VS Code documentation, ensure that you have
[Git](https://git-scm.com/downloads) installed.

Clone a copy of the repo:

```
git clone https://github.com/Microsoft/vscode-docs.git
```

VS Code itself is great for reviewing and editing [Markdown](https://code.visualstudio.com/docs/languages/markdown) with nice preview support.
VS Code itself is great for reviewing and editing
[Markdown](https://code.visualstudio.com/docs/languages/markdown) with nice
preview support.

If you want to use VS Code, simply navigate to the `vscode-docs` directory and launch VS Code from there:
If you want to use VS Code, simply navigate to the `vscode-docs` directory and
launch VS Code from there:

```
cd vscode-docs
code .
```

You can open any of the Markdown files and see a preview with the **Open Preview to the Side** button in the upper right of the editor.
You can open any of the Markdown files and see a preview with the **Open Preview
to the Side** button in the upper right of the editor.

![Markdown Preview Button](images/MDPreviewButton.png)

## Publishing

Steps for how to publish documentation changes can be found [here](https://github.com/Microsoft/vscode-website#publishing-a-documentation-change) in the (private) repository of the VS Code website.
Steps for how to publish documentation changes can be found
[here](https://github.com/Microsoft/vscode-website#publishing-a-documentation-change)
in the (private) repository of the VS Code website.
30 changes: 22 additions & 8 deletions api/advanced-topics/extension-host.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,21 +4,35 @@ ContentId: 106AA11C-DB26-493A-9E3C-16F513B2AEC8
DateApproved: 3/7/2019

# Summarize the whole topic in less than 300 characters for SEO purpose
MetaDescription: The Visual Studio Code Extension Host is responsible for managing extensions and ensuring the stability and performance of Visual Studio Code.
MetaDescription:
The Visual Studio Code Extension Host is responsible for managing extensions
and ensuring the stability and performance of Visual Studio Code.
---

# Extension Host

As you learned in the [Extension Anatomy](/api/get-started/extension-anatomy) topic, an extension exposes the `activate` and `deactivate` methods and VS Code will manage its lifecycle. This topic provides more details on the **Extension Host** that manages all running extensions.
As you learned in the [Extension Anatomy](/api/get-started/extension-anatomy)
topic, an extension exposes the `activate` and `deactivate` methods and VS Code
will manage its lifecycle. This topic provides more details on the **Extension
Host** that manages all running extensions.

**Extension host** is a Node.js process in VS Code responsible for loading and running extensions. Although you don't need to worry about the Extension Host when you are writing extensions, it is still useful to know what the Extension Host does to your extension.
**Extension host** is a Node.js process in VS Code responsible for loading and
running extensions. Although you don't need to worry about the Extension Host
when you are writing extensions, it is still useful to know what the Extension
Host does to your extension.

## Stability and Performance

VS Code aims to deliver a stable and performant editor to end users, and misbehaving extensions should not impact the user experience. The Extension Host in VS Code prevents extensions from:
VS Code aims to deliver a stable and performant editor to end users, and
misbehaving extensions should not impact the user experience. The Extension Host
in VS Code prevents extensions from:

- Impacting startup performance
- Slowing down UI operations
- Modifying the UI
- Impacting startup performance
- Slowing down UI operations
- Modifying the UI

Additionally, VS Code lets extensions declare its [Activation Events](/api/references/activation-events) and loads them lazily. For example, the Markdown extension should only be loaded when a user opens a Markdown file. This makes sure that extensions do not consume unnecessary CPU and memory.
Additionally, VS Code lets extensions declare its
[Activation Events](/api/references/activation-events) and loads them lazily.
For example, the Markdown extension should only be loaded when a user opens a
Markdown file. This makes sure that extensions do not consume unnecessary CPU
and memory.
21 changes: 16 additions & 5 deletions api/advanced-topics/using-proposed-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,25 @@ MetaDescription: Use Visual Studio Code's Proposed API

# Using Proposed API

At Visual Studio Code, we take Extension API compatibility seriously. We give our best effort to avoid breaking API changes, and extension authors could expect published extensions to continue to work. However, this puts great limitation on us: once we introduce an API, we cannot easily change it any more.
At Visual Studio Code, we take Extension API compatibility seriously. We give
our best effort to avoid breaking API changes, and extension authors could
expect published extensions to continue to work. However, this puts great
limitation on us: once we introduce an API, we cannot easily change it any more.

Proposed API solves the problem for us. Proposed API is a set of unstable API that are implemented in VS Code but not exposed to the public as stable API does. They are **subject to change**, **only available in Insider distribution** and **cannot be used in published extensions**. Nevertheless, extension authors could test these new API in local development and provide feedback for VS Code team to iterate on the API. Eventually, Proposed API finds their way into the stable API and becomes available for general use.
Proposed API solves the problem for us. Proposed API is a set of unstable API
that are implemented in VS Code but not exposed to the public as stable API
does. They are **subject to change**, **only available in Insider distribution**
and **cannot be used in published extensions**. Nevertheless, extension authors
could test these new API in local development and provide feedback for VS Code
team to iterate on the API. Eventually, Proposed API finds their way into the
stable API and becomes available for general use.

## Using Proposed API

These are the steps for testing Proposed API in local extension development:

- Use [Insiders](/insiders) release of VS Code.
- Add `"enableProposedApi": true` to your `package.json`.
- Copy the latest version of the [`vscode.proposed.d.ts`](https://github.com/Microsoft/vscode/blob/master/src/vs/vscode.proposed.d.ts) into your project.
- Use [Insiders](/insiders) release of VS Code.
- Add `"enableProposedApi": true` to your `package.json`.
- Copy the latest version of the
[`vscode.proposed.d.ts`](https://github.com/Microsoft/vscode/blob/master/src/vs/vscode.proposed.d.ts)
into your project.
Loading

0 comments on commit a386dfc

Please sign in to comment.