Skip to content

Commit 11403ef

Browse files
committed
📝 Update README, CONTRIBUTING, and graphical abstract figure
1 parent 71f1f7f commit 11403ef

File tree

3 files changed

+13
-10
lines changed

3 files changed

+13
-10
lines changed

CONTRIBUTING.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -27,16 +27,17 @@ you to share any suggestions or observations you have about this project.
2727

2828
Here are the ways you can submit your suggestions and contribute to the project:
2929

30-
1. **Reporting Issues or Suggesting Improvements:** If you have a [GitHub][github] account
31-
(or are willing to [open one][github-join]) but are unfamiliar with Git, you can report
32-
bugs or suggest improvements by [creating an issue][new-issue]. This GitHub feature allows
33-
for discussion threads on reported issues and proposed enhancements.
30+
### 1. Reporting Issues or Suggesting Improvements
3431

35-
2. **Submitting Changes via Pull Requests:** If you are comfortable using Git and would like to
36-
add or modify a functionality, you can submit a **pull request (PR)**. Instructions on how to contribute this way are provided in the next section.
32+
If you have a [GitHub][github] account (or are willing to [open one][github-join]) but are unfamiliar with Git, you can report bugs or suggest improvements by [creating an issue][new-issue]. This GitHub feature allows for discussion threads on reported issues and proposed enhancements.
3733

38-
3. **Providing Feedback via Email:** If you don’t have a GitHub account and are
39-
unfamiliar with Git, you can send feedback via email to [[email protected]][contact]. However, using GitHub is preferred, as it allows us to respond more quickly and track discussions openly.
34+
### 2. Submitting Changes via Pull Requests
35+
36+
If you are comfortable using Git and would like to add or modify a functionality, you can submit a **pull request (PR)**. Instructions on how to contribute this way are provided in the next section.
37+
38+
### 3. Providing Feedback via Email
39+
40+
If you don’t have a GitHub account and are unfamiliar with Git, you can send feedback via email to [[email protected]][contact]. However, using GitHub is preferred, as it allows us to respond more quickly and track discussions openly.
4041

4142
> [!NOTE]
4243
> The documentation for [Git][git-docs] and [GitHub][github-docs] are easy to follow, and you can learn the basics using their official guides.

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ If you prefer not to install VueGen on your system, a pre-configured Docker cont
9898

9999
### Nextflow and nf-core
100100

101-
VueGen is also available as a [nf-core][nfcore] module, customised for compatibility with the [Nextflow][nextflow] environment. This module is designed to automate report generation from outputs produced by other modules, subworkflows, or pipelines. The code and documentation for the nf-core module are available in the [nf-VueGen repository][nf-vuegen].
101+
VueGen is also available as a [nf-core][nfcore] module, customised for compatibility with the [Nextflow][nextflow] environment. This module is designed to automate report generation from outputs produced by other modules, subworkflows, or pipelines. You can read the offical documentation for the nf-core module [here](nf-vuegen-nf-core). Also, the source code and detailed documentation are available in the [nf-VueGen repository][nf-vuegen].
102102

103103
## Execution
104104

@@ -255,7 +255,8 @@ This advanced case study demonstrates the application of VueGen in a real-world
255255
### 3. ChatBot Component
256256

257257
This case study highlights VueGen’s capability to embed a chatbot component into a report subsection,
258-
enabling interactive conversations inside the report.
258+
enabling interactive conversations inside the report. This component is streamlit-specific and is not
259+
available for other report types.
259260

260261
Two API modes are supported:
261262

@@ -360,6 +361,7 @@ We appreciate your feedback! If you have any comments, suggestions, or run into
360361
[nfcore]: https://nf-co.re/
361362
[nextflow]: https://www.nextflow.io/
362363
[nf-vuegen]: https://github.com/Multiomics-Analytics-Group/nf-vuegen/
364+
[nf-vuegen-nf-core]: https://nf-co.re/modules/vuegen/
363365
[colab_badge]: https://colab.research.google.com/assets/colab-badge.svg
364366
[colab_link_intro_demo]: https://colab.research.google.com/github/Multiomics-Analytics-Group/vuegen/blob/main/docs/vuegen_basic_case_study.ipynb
365367
[predef-dir-config]: https://github.com/Multiomics-Analytics-Group/vuegen/blob/main/docs/example_config_files/Basic_example_vuegen_demo_notebook_config.yaml
-3.4 MB
Loading

0 commit comments

Comments
 (0)