Merge branch 'main' of github.com:bioimage-io/bioimageio-chatbot

bioimage-io · Jun 7, 2024 · d444e7f · d444e7f
2 parents 725a22b + 2bdf082
commit d444e7f
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 5 deletions.
diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md
@@ -7,6 +7,7 @@ Thank you for your interest in contributing to the BioImage.IO Chatbot. Your con
 The BioImage.IO Chatbot relies on a comprehensive knowledge base to provide accurate responses to user queries. We encourage contributions to expand this knowledge base by adding new databases, information, or resources. Whether you're a researcher, developer, or domain expert, your contributions can help improve the chatbot's functionality.
 
 ## Contribution Process
+### Knowledge Base
 
 You can contribute to the chatbot's knowledge base by adding new databases or information.
 
@@ -22,6 +23,11 @@ Follow these steps to contribute to the BioImage.IO Chatbot:
 
 Remember that, in any step of the process you can contact us to look for feedback or assistance. We deeply appreciate your contribution!
 
+### Develop Custom Extenstion
+
+The BioImage.IO Chatbot offers a framework designed for easy extensibility, allowing developers to enrich its capabilities with custom extensions. Please check details on how to contribute to the chatbot by developing custom extension [`Developing Chatbot Extensions`](./development.md).
+
+
 ## Contact Us
 
 If you have any questions, need assistance, or want to contribute to the chatbot's knowledge base, please don't hesitate to contact us via [Github issues](https://github.com/bioimage-io/bioimageio-chatbot/issues). Our team is here to help you get started and make valuable contributions.
diff --git a/docs/README.md b/docs/README.md
@@ -102,12 +102,18 @@ To reproduce the use cases described in [Figure 2](https://docs.google.com/drawi
 
 ## Cite Us
 
-If you use the BioImage.IO Chatbot in your research, please cite us:
+If you use the BioImage.IO Chatbot in your research, please cite us: <a href="https://zenodo.org/records/10032227" target="_blank"><img id="record-doi-badge" data-target="[data-modal='10.5281/zenodo.10032228']" src="https://zenodo.org/badge/DOI/10.5281/zenodo.10032228.svg" alt="10.5281/zenodo.10032228"></a>
+
 
 ```
 Lei, W., Fuster-Barceló, C., Muñoz-Barrutia, A., & Ouyang, W. (2023). 🦒BioImage.IO Chatbot: A Personalized Assistant for BioImage Analysis Augmented by Community Knowledge Base (0.1.0). Zenodo. https://doi.org/10.5281/zenodo.10032228
 ```
 
+You can also reference our preprint available on arXiv: [![arXiv](https://img.shields.io/badge/arXiv-2310.18351-red.svg)](https://arxiv.org/abs/2310.18351) 
+```
+Lei, W., Fuster-Barceló, C., Muñoz-Barrutia, A., & Ouyang, W. (2023). 🦒BioImage.IO Chatbot: A Personalized Assistant for BioImage Analysis Augmented by Community Knowledge Base. arXiv. https://arxiv.org/abs/2310.18351
+```
+
 ## Acknowledgements
 
 We thank [AI4Life consortium](https://ai4life.eurobioimaging.eu/) for its crucial support in the development of the BioImage.IO Chatbot.

diff --git a/docs/technical-overview.md b/docs/technical-overview.md
@@ -34,8 +34,7 @@ The BioImage.IO Chatbot employs diverse methods to generate responses, currently
 
 ### Search BioImage Docs
 This extension allows the chatbot to search information in a community-driven bioimage related knowledge base. With a specific query, the chatbot extracts essential elements from the user's question to fetch information from the relevant documentation. 
-
-    ![direct-response](./screenshots/search-bioimage-docs.png)
+        ![direct-response](./screenshots/search-bioimage-docs.png)
     *Figure 6. Search in Bioimage Knolwedge base documentation.*
 
 ### Search BioImage Information Index (biii.eu)
@@ -57,14 +56,12 @@ This extension allows the chatbot to search bioimage related topics and software
 
 ### Search Web
 This extension allows the chatbot to search for information from the web. This extension is triggered while the chatbot realizes it can not find relevant information from the knowledge base.
-
     ![search-web](./screenshots/search-web.png)
     *Figure 10. Search in the web.*
 
 
 ### BioImage Model Zoo
 This mode is designed for queries requiring detailed model information or specific actions, generating and executing Python scripts for tailored solutions.
-
     ![script-gen-exe-retrieval](./screenshots/search-model-zoo.png)
     *Figure 11. Scripting retrieval for complex queries.*