Skip to content

Commit 4a0ce24

Browse files
authored
Merge pull request #140 from bioimage-io/alalulu8668-patch-3
Update documentation
2 parents 74e3d44 + c229c99 commit 4a0ce24

File tree

2 files changed

+7
-4
lines changed

2 files changed

+7
-4
lines changed

docs/CONTRIBUTING.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ Thank you for your interest in contributing to the BioImage.IO Chatbot. Your con
77
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.
88

99
## Contribution Process
10+
### Knowledge Base
1011

1112
You can contribute to the chatbot's knowledge base by adding new databases or information.
1213

@@ -22,6 +23,11 @@ Follow these steps to contribute to the BioImage.IO Chatbot:
2223

2324
Remember that, in any step of the process you can contact us to look for feedback or assistance. We deeply appreciate your contribution!
2425

26+
### Develop Custom Extenstion
27+
28+
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).
29+
30+
2531
## Contact Us
2632

2733
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.

docs/technical-overview.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,7 @@ The BioImage.IO Chatbot employs diverse methods to generate responses, currently
3434

3535
### Search BioImage Docs
3636
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.
37-
38-
![direct-response](./screenshots/search-bioimage-docs.png)
37+
![direct-response](./screenshots/search-bioimage-docs.png)
3938
*Figure 6. Search in Bioimage Knolwedge base documentation.*
4039

4140
### Search BioImage Information Index (biii.eu)
@@ -57,14 +56,12 @@ This extension allows the chatbot to search bioimage related topics and software
5756

5857
### Search Web
5958
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.
60-
6159
![search-web](./screenshots/search-web.png)
6260
*Figure 10. Search in the web.*
6361

6462

6563
### BioImage Model Zoo
6664
This mode is designed for queries requiring detailed model information or specific actions, generating and executing Python scripts for tailored solutions.
67-
6865
![script-gen-exe-retrieval](./screenshots/search-model-zoo.png)
6966
*Figure 11. Scripting retrieval for complex queries.*
7067

0 commit comments

Comments
 (0)