Changes on docs based on feedback from users

Changes on the documentation according to the feedback recieved and specified in the Meeting Minutes (#28)

docs/README.md

@@ -5,8 +5,9 @@ Welcome to the official BioImage.IO documentation. Here, you'll find comprehensi
 ## Quick Navigation
 
 - **[Getting Started](/getting_started/README.md)**: Introduction to the BioImage Model Zoo ecosystem, who are we and how can you be part of it.
-- **[User GUide](/guides/user-guide.md)**: This guide is intended for users wanting to consume or use models from the BioImage Model Zoo. There are plenty of models in the BioImage Model Zoo that you can use in your own software, in the software of our community partners or you can even download them and use them in a notebook or code of your own.
-- **[Developers Guide](/guides/developers-guide.md)**: This guide is intended for developers wanting to contribute to the BioImage Model Zoo. You can contribute to the BioImage Model Zoo by adding new models, improving existing models, or by contributing to the ecosystem in other ways.
+- **[How to use the BioImage Model Zoo](/guides/user-guide.md)**: This guide is intended for users wanting to consume or use models from the BioImage Model Zoo. There are plenty of models in the BioImage Model Zoo that you can use in your own software, in the software of our community partners or you can even download them and use them in a notebook or code of your own.
+- **[How to contribute models](/guides/developers-guide.md)**: This guide is intended for developers wanting to contribute or upload models to the BioImage Model Zoo. 
+- **[Other contributions](/guides/other-contributions.md)**: This guide is intended for users wanting to contribute to the BioImage Model Zoo in other ways than uploading models.
 - **[Community Partners Guide](/guides/community-partners-guide.md)**: Community Partners wanting to integrate their software in to the BioImage Model Zoo can follow this guide to learn how to do so. 
 - **[Tools and Resources](/tools_and_resources/README.md)**: Overview of the available tools and resources linked to the BioImage Model Zoo.
 - **[Help Desk](/help_desk/README.md)**: A bit lost? Check the help desk for more information, a glossary page and how to contact us!

docs/_sidebar.md

@@ -1,8 +1,9 @@
 <!-- docs/_sidebar.md -->
 * [Welcome](/README.md)
 * [Getting Started](/getting_started/README.md)
-* [User Guide](/guides/user-guide.md)
-* [Developers Guide](/guides/developers-guide.md)
+* [How to use the BioImage Model Zoo](/guides/user-guide.md)
+* [How to contribute models to the BioImage Model Zoo](/guides/developers-guide.md)
+* [Other contributions](/guides/other-contributions.md)
 * [Community Partners Guide](/guides/community-partners-guide.md)
 * [Tools and Resources](/tools_and_resources/README.md)
 * [Help Desk](/help_desk/README.md)

docs/guides/developers-guide.md

@@ -1,4 +1,4 @@
-# Developers Guide
+# How to contribute models to the BioImage Model Zoo
 This guide is intended for developers who want to contribute models to the BioImage Model Zoo. It provides detailed instructions on creating, validating, and uploading models to the platform. By following these steps, you can ensure that your models are compatible with BioImage.IO consumer software and accessible to the broader life-sciences community.
 
 ## Content
@@ -202,16 +202,3 @@ For further details, visit the [BioImage.IO RDF specification repository](https:
 
 
 
-## Other contributions
-You are welcome to submit your **models**, **datasest**, **applicaitons** and Jupyter **notebooks** to BioImage.IO.
-
-To add an resource item to BioImage.IO, you need to provide a set of basic information about the resouce, including name, description, authors etc. and we will generate a resource card to display in the website.
-
-For Community Partners, you can add models directly to the linked repository. If you are not part of the community partners, you can follow the instructions below to submit resource items (models, datasets etc.) to BioImage.IO.
-
-### Submit to BioImage.IO
-* Step 1, prepare a [`Resource Description File`](/bioimageio_rdf_spec)(RDF) and complete at least the mandatory fields and ideally also the recommended fields for different types of resource.
-
-* Step 2, save the RDF file in one of the public git hosting website, it is recommended to store the RDF file in your project git repository on Github/Gitlab/Bitbucket (make sure it's a public repo). Alternatively, you can post it on [Gist](https://gist.github.com/), copy the the **raw** url to the actual file content.
-
-* Step 3, post the url to the comment box below (if you don't see it, click [here](https://github.com/bioimage-io/bioimage-io-models/issues/26)). And the admin team will check and verify the format and incooperate to BioImage.IO if the submitted file is qualified.

docs/guides/other-contributions-guide.md

@@ -0,0 +1,13 @@
+# Other contributions
+You are welcome to submit your **models**, **datasest**, **applicaitons** and Jupyter **notebooks** to BioImage.IO.
+
+To add an resource item to BioImage.IO, you need to provide a set of basic information about the resouce, including name, description, authors etc. and we will generate a resource card to display in the website.
+
+For Community Partners, you can add models directly to the linked repository. If you are not part of the community partners, you can follow the instructions below to submit resource items (models, datasets etc.) to BioImage.IO.
+
+## Submit to BioImage.IO
+* Step 1, prepare a [`Resource Description File`](/bioimageio_rdf_spec)(RDF) and complete at least the mandatory fields and ideally also the recommended fields for different types of resource.
+
+* Step 2, save the RDF file in one of the public git hosting website, it is recommended to store the RDF file in your project git repository on Github/Gitlab/Bitbucket (make sure it's a public repo). Alternatively, you can post it on [Gist](https://gist.github.com/), copy the the **raw** url to the actual file content.
+
+* Step 3, post the url to the comment box below (if you don't see it, click [here](https://github.com/bioimage-io/bioimage-io-models/issues/26)). And the admin team will check and verify the format and incooperate to BioImage.IO if the submitted file is qualified.

docs/guides/user-guide.md

@@ -1,4 +1,4 @@
-# User Guide
+# How to use the BioImage Model Zoo
 This guide is intended for users wanting to consume or use models from the BioImage Model Zoo. There are plenty of models in the BioImage Model Zoo that you can use in your own software, in the software of our community partners or you can even download them and use them in a notebook or code of your own.
 
 ## Content

docs/help_desk/README.md

@@ -7,9 +7,10 @@ In the ever-evolving field of bioimage analysis, understanding the terminology i
 | ------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | **Community Partner**                 | Usually, a community partner is an organization, a company, a research group, or a software team (of one or more) that can consume and/or produce resources of the BioImage Model Zoo. Additionally, most partners continuously and openly contribute resources of their own. The founders community partners represent open source consumer software of [BioImage.IO](http://BioImage.IO/) (e.g. [ilastik](https://www.ilastik.org), [Fiji](https://imagej.net/software/fiji/), [deepImageJ](https://deepimagej.github.io), [ZeroCostDL4Mic](https://github.com/HenriquesLab/ZeroCostDL4Mic), [StarDist](https://github.com/stardist/stardist)). A Community Partner can either be a team behind a software which produces or consumes trained models compatible with the [BioImage.IO](http://bioimage.io/) spec or an organization, group, company or team (of one or more) who contributed and will keep contributing more models to BioImage Model Zoo. |
 | **Consumer**                          | Refers to an individual or user who engages with the project by utilizing the pre-existing models available on [BioImage.IO](http://bioimage.io/). Their primary role involves downloading these models and incorporating them into their workflow using compatible software or any specific manner that suits their needs. For example, a Life Scientist can be considered a consumer by accessing the[BioImage.IO](http://bioimage.io/), selecting a Deep Learning model relevant to their research, and integrating it into their preferred software, such as deepImageJ or other compatible platforms. As a consumer, their focus lies in leveraging the existing models to enhance their bioimage analysis tasks, thereby benefiting from the diverse range of models provided by the BioImage Model Zoo. |
-| **Contributor**                       | A contributor can either be an individual person or a group, entity, or software. As an individual contributor, your primary objective is to actively contribute to the project by uploading models to BioImage Model Zoo. By doing so, you expand the range of available models, enriching the repository and fostering the growth of the bioimage analysis community. As a contributor, you play a crucial role in sharing your expertise and innovative models with the broader community, contributing to advancements in bioimage analysis. Similarly, a software contributor refers to a software application or system that actively participates in the project by uploading models to [BioImage.IO](http://bioimage.io/). These software contributors enhance the available models by providing new and diverse solutions, further expanding the capabilities of the BioImage Model Zoo. Whether you contribute as an individual or a software entity, your active involvement in uploading models to [BioImage.IO](http://bioimage.io/) is instrumental in supporting the project's objectives. By sharing your models, you contribute to the collective knowledge and empower researchers in the bioimage analysis field. |
+| **Contributor/Producer**                       | A contributor can either be an individual person or a group, entity, or software. As an individual contributor, your primary objective is to actively contribute to the project by uploading models to BioImage Model Zoo. By doing so, you expand the range of available models, enriching the repository and fostering the growth of the bioimage analysis community. As a contributor, you play a crucial role in sharing your expertise and innovative models with the broader community, contributing to advancements in bioimage analysis. Similarly, a software contributor refers to a software application or system that actively participates in the project by uploading models to [BioImage.IO](http://bioimage.io/). These software contributors enhance the available models by providing new and diverse solutions, further expanding the capabilities of the BioImage Model Zoo. Whether you contribute as an individual or a software entity, your active involvement in uploading models to [BioImage.IO](http://bioimage.io/) is instrumental in supporting the project's objectives. By sharing your models, you contribute to the collective knowledge and empower researchers in the bioimage analysis field. |
 | **Consumer Software**                 | A consumer software refers to any software application or tool that utilizes the models from the BioImage Model Zoo repository. Consumer software is designed to interact with and make use of the pretrained AI models available in the BioImage Model Zoo. A consumer software is any software application or tool that utilize pretrained AI models for bioimage analysis tasks, either through integration, execution, or interaction with the models available in the BioImage Model Zoo. |
 | **Model Resource Description File Specifications (RDF YAML)** | The Model Resource Description File (RDF) specifications refer to a set of guidelines that define the structure and content of a YAML file used to describe the AI models with pretrained weights in a standardized format. The model RDF serves as a metadata file that provides essential information about the model, its properties, and its intended use. The RDF file contains both mandatory and optional fields that capture relevant details about the model, such as its architecture, input/output formats, preprocessing steps, and performance metrics. By following the Model RDF specifications, developers and researchers can create consistent and interoperable descriptions of their AI models, allowing seamless integration and sharing within the [BioImage.IO](http://bioimage.io/) ecosystem. |
+| **Cross-compatibility** | Cross-compatibility refers to the ability of a model or software to function across different platforms, systems, or environments without requiring modifications or adaptations. In the context of the BioImage Model Zoo, cross-compatibility ensures that the pretrained AI models and consumer software are interoperable and can be seamlessly integrated into various bioimage analysis workflows. By adhering to cross-compatibility standards, developers and users can access and utilize the models across different software applications and platforms, enhancing the accessibility and usability of the BioImage Model Zoo resources. |
 
 ## FAQs
 
@@ -35,6 +36,10 @@ A Community Partner can either be a team behind a software which produces or con
 
 To contribute a model to the BioImage Model Zoo, please refer to the [Contribute Models section](https://bioimage.io/docs/#/contribute_models/README). This section provides detailed instructions on how to upload a model, including the necessary steps and required files for your contribution.
 
+**What does it mean that the model should be cross-compatible among different software?**
+
+Models from the BioImage Model Zoo adhere to [the specs](https://github.com/bioimage-io/spec-bioimage-io?tab=readme-ov-file#specifications-for-bioimageio), a standarised format that allows the models to be used across different software applications. This means that if the uploaded models follow this standarisation, they will be cross-compatible among the different software or community partners that consume them. When uploading a model to the BioImage Model Zoo you need to ensure that the model will be cross-compatible among different software by adhering to the BioImage Model Zoo specifications.
+
 **How can I report issues or provide feedback regarding models on BioImage.IO?**
 
 If you encounter a bug or wish to share feedback, please use our [GitHub issues page](https://github.com/bioimage-io/bioimage.io/issues). We appreciate your input and kindly request that you ensure your feedback is not duplicated. Your contributions help improve the BioImage Model Zoo for the entire community.