docs: Update installation.md with bug reporting information

ylab-hi · Oct 29, 2023 · f66e648 · f66e648
1 parent baff890
commit f66e648
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 15 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -33,7 +33,7 @@ repos:
         exclude: docs/tutorial.md
 
   - repo: https://github.com/crate-ci/typos
-    rev: typos-dict-v0.11.2
+    rev: v1.16.21
     hooks:
       - id: typos
         exclude: "extc|svg|psl|CHANGELOG"
diff --git a/docs/installation.md b/docs/installation.md
@@ -66,6 +66,13 @@ Below is a compatibility matrix that shows the support status of **PxBLAT** acro
   pip install pxblat
   ```
 
+```{bug}
+As we continuously strive to improve the precision and comprehensibility of this documentation, your insights and observations become crucial.
+Should you come across any inconsistencies or issues, we encourage you to [open an issue](https://github.com/ylab-hi/pxblat/issues/new/choose) on our GitHub repository.
+Your contributions are immensely valuable, playing a pivotal role in helping us uphold and enhance the quality and accuracy of our documentation.
+We appreciate your commitment to excellence and look forward to your feedback.
+```
+
 You've successfully installed **PxBLAT**! Feel free to dive into a real usage case ({doc}`tutorial`) to start exploring its functionalities.
 
 <!-- links -->

diff --git a/poetry.lock b/poetry.lock