Skip to content

Commit 67b6e9e

Browse files
committed
Update README and welcome pages
Signed-off-by: Ben Sherman <[email protected]>
1 parent 916be95 commit 67b6e9e

File tree

3 files changed

+30
-34
lines changed

3 files changed

+30
-34
lines changed

README.md

Lines changed: 21 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,6 @@
11
# Nextflow extension for Visual Studio Code
22

3-
VS Code extension for [Nextflow](https://www.nextflow.io/) that provides language support for scripts and config files, using the [Nextflow language server](https://github.com/nextflow-io/language-server).
4-
5-
Read the blog posts ([part 1](https://seqera.io/blog/modernizing-nextflow-developer-experience/), [part 2](https://seqera.io/blog/modernizing-nextflow-developer-experience-part-2/)) and the [docs](https://nextflow.io/docs/latest/vscode.html) for more information.
6-
7-
See also:
8-
9-
- [VSCode Marketplace](https://marketplace.visualstudio.com/items?itemName=nextflow.nextflow)
10-
- [Open VSX Registry](https://www.open-vsx.org/extension/nextflow/nextflow)
3+
VS Code extension for [Nextflow](https://www.nextflow.io/) that provides language support for Nextflow scripts and config files.
114

125
## Features
136

@@ -26,6 +19,13 @@ The extension uses the [Nextflow language server](https://github.com/nextflow-io
2619
- Rename
2720
- DAG preview for workflows
2821

22+
Read the [Nextflow documentation](https://nextflow.io/docs/latest/vscode.html) for more information about the Nextflow language server.
23+
24+
Related blog posts:
25+
26+
- [Modernizing the Nextflow Developer Experience (Part 1): The IDE](https://seqera.io/blog/modernizing-nextflow-developer-experience/)
27+
- [Modernizing the Nextflow Developer Experience (Part 2): The Language Server](https://seqera.io/blog/modernizing-nextflow-developer-experience-part-2/)
28+
2929
### Copilot for Nextflow
3030

3131
![VS Code Copilot Extension](images/chat-usage.gif)
@@ -40,6 +40,10 @@ The extension includes a GitHub Copilot extension specifically trained for Nextf
4040
- `/dsl2` - Convert DSL1 scripts to DSL2
4141
- `/nf-test` - Assists in generating nf-test test cases and improving test coverage
4242

43+
Related blog posts:
44+
45+
- [Bringing Seqera AI to the Nextflow VS Code extension](https://seqera.io/blog/seqera-ai--nextflow-vs-code/)
46+
4347
### Workflows and Processes View
4448

4549
The extension provides custom views for managing Nextflow workflows and processes.
@@ -59,7 +63,11 @@ This view helps you:
5963

6064
![Process View](images/process_view.png)
6165

62-
## Requirements
66+
## Installation
67+
68+
This extension is available in the [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=nextflow.nextflow) and the [Open VSX Registry](https://www.open-vsx.org/extension/nextflow/nextflow).
69+
70+
### Requirements
6371

6472
The language server requires Java 17 or later.
6573

@@ -78,6 +86,10 @@ The extension will fall back to the latest patch version from the local cache if
7886

7987
*Note: Nextflow language server patch versions have no correlation to Nextflow patch versions. Always use the latest patch version of the language server when downloading a release manually.*
8088

89+
## Commands
90+
91+
Open the command palette and type `Nextflow` to see the list of available commands.
92+
8193
## Configuration
8294

8395
The following settings are available:

src/welcomePage/welcome-cursor.md

Lines changed: 5 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,14 @@
11
# Nextflow extension for Cursor
22

3-
## Available commands
3+
## Commands
44

5-
Open the command palette and type `Nextflow` to see the following commands:
6-
7-
- Show Welcome Page
8-
- Chat with Seqera
9-
- Convert to DSL2 with Seqera
10-
- Restart language server
11-
- Stop language server
5+
Open the command palette and type `Nextflow` to see the list of available commands.
126

137
## Language server
148

15-
The extension will automatically download a language server release based on the "Nextflow > Target Version" extension setting.
9+
The extension will automatically download a language server release based on the `nextflow.targetVersion` extension setting.
10+
11+
Read the [Nextflow documentation](https://nextflow.io/docs/latest/vscode.html) for more information about the Nextflow language server.
1612

1713
## Seqera AI
1814

@@ -31,10 +27,6 @@ In order for Cursor to have access to the Nextflow docs, perform the following s
3127

3228
Now you will be able to use the `@Nextflow` command in Cursor Chat. The same can be done for MultiQC or other tools.
3329

34-
## Documentation
35-
36-
Read the [Nextflow documentation](https://nextflow.io/docs/latest/vscode.html) for more information about using the Nextflow extension.
37-
3830
## Telemetry
3931

4032
Telemetry is opt-in and can be enabled or disabled at any time. See our [Telemetry notice](vscode:extension/nextflow.nextflow) on the extension page for more information about what we do and do not collect.

src/welcomePage/welcome-vscode.md

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,14 @@
11
# Nextflow extension for VS Code
22

3-
## Available commands
3+
## Commands
44

5-
Open the command palette and type `Nextflow` to see the following commands:
6-
7-
- Show Welcome Page
8-
- Chat with Seqera
9-
- Convert to DSL2 with Seqera
10-
- Restart language server
11-
- Stop language server
5+
Open the command palette and type `Nextflow` to see the list of available commands.
126

137
## Language server
148

15-
The extension will automatically download a language server release based on the "Nextflow > Target Version" extension setting.
16-
17-
## Documentation
9+
The extension will automatically download a language server release based on the `nextflow.targetVersion` extension setting.
1810

19-
Read the [Nextflow documentation](https://nextflow.io/docs/latest/vscode.html) for more information about using the Nextflow extension.
11+
Read the [Nextflow documentation](https://nextflow.io/docs/latest/vscode.html) for more information about the Nextflow language server.
2012

2113
## Telemetry
2214

0 commit comments

Comments
 (0)