Skip to content

Commit

Permalink
docs(visual-studio): add Visual Studio installation instructions and …
Browse files Browse the repository at this point in the history
…to main readme
  • Loading branch information
chrissimon-au committed Sep 4, 2024
1 parent c3c5324 commit e751dc1
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 3 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ Officially supported IDEs include:

#### [VsCode](./docs/wiki/INSTALLATION.md#visual-studio-code)
#### [IntelliJ IDEs](./docs/wiki/INSTALLATION.md#intellij-plugin-platform)
#### [Visual Studio](./docs/wiki/INSTALLATION.md#visual-studio-2022)
#### [Neovim](./docs/wiki/INSTALLATION.md#neovim)
#### [Helix](./docs/wiki/INSTALLATION.md#helix)

Expand Down
11 changes: 11 additions & 0 deletions docs/wiki/INSTALLATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,17 @@ See JetBrains documentation on [installing plugins](https://www.jetbrains.com/he

Check the plugin [README](../../src/intellij/contextive/README.md) for usage instructions, known issues and links to related JetBrains issues with the Language Server Protocol support.

## Visual Studio 2022

Open Visual Studio 2022. Use the `Extensions` -> `Manage Extensions...` menu option. Search for `Contextive` and click `Install`.

> [!WARNING]
> This plugin is considered 'beta' status, as leverages relatively new [Language Server Protocol](https://learn.microsoft.com/en-us/visualstudio/extensibility/visualstudio.extensibility/language-server-provider/language-server-provider?view=vs-2022) support in the [Preview Extensibility Model](https://learn.microsoft.com/en-us/visualstudio/extensibility/visualstudio.extensibility/?view=vs-2022). Some features may not work or may not work as expected. Please [report issues](https://github.com/dev-cycles/contextive/issues/new?assignees=&labels=&projects=&template=bug_report.md&title=) in this project and we will liaise with Microsoft & the Visual Studio team to resolve.
>
> The main issue for most use cases is that the extension doesn't work when opening a solution file, only when opening a folder. See [Issue #75](https://github.com/dev-cycles/contextive/issues/75) for details.
>
> See [known issues](../../src/visualstudio/contextive/contextive/README.md#known-issues) for others.
## Language Server Configurations

For the following IDEs, you will need to install the Contextive Language Server and then configure the IDE to use it.
Expand Down
4 changes: 1 addition & 3 deletions src/visualstudio/contextive/contextive/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@ Contextive is a Visual Studio Code extension to assist developers in environment

It should help new team members get up to speed more quickly in understanding domain-specific terms. By storing the term definitions in your repository, and surfacing the definitions as you work on the code, it encourages the use of the domain-specific terms in your code, and regularly updating the definitions as the team's understanding evolves.

![Example of Contextive in action.](https://raw.githubusercontent.com/dev-cycles/contextive/v1.12.0/docs/wiki/images/simple-auto-complete-demo.gif)

> [!WARNING]
> This plugin is considered 'beta' status, as leverages relatively new [Language Server Protocol](https://learn.microsoft.com/en-us/visualstudio/extensibility/visualstudio.extensibility/language-server-provider/language-server-provider?view=vs-2022) support in the [Preview Extensibility Model](https://learn.microsoft.com/en-us/visualstudio/extensibility/visualstudio.extensibility/?view=vs-2022). Some features may not work or may not work as expected. Please [report issues](https://github.com/dev-cycles/contextive/issues/new?assignees=&labels=&projects=&template=bug_report.md&title=) in this project and we will liaise with Microsoft & the Visual Studio team to resolve.
>
Expand All @@ -18,7 +16,7 @@ It should help new team members get up to speed more quickly in understanding do
## Installation

See [VsCode Installation Instructions](https://raw.githubusercontent.com/dev-cycles/contextive/v1.12.0/docs/wiki/INSTALLATION.md#visual-studio-code).
See [Visual Studio Instructions](https://github.com/dev-cycles/contextive/blob/v1.12.0/docs/wiki/INSTALLATION.md#visual-studio-2022).

## Getting Started

Expand Down

0 comments on commit e751dc1

Please sign in to comment.