Documentation Default Behavior and Suggestion for Improvement

[cfusterbarcelo]

Issue:

As discussed in yesterday's meeting, the default documentation displayed on a model card currently seems to be the documentation from the specs repository. This behavior can be observed in models like chatty-frog:

The same behavior is also present in the placid-llama model.

Suggestion:

It would be helpful to include a message in such cases to clarify the absence of custom documentation. For example:

"There is no attached documentation provided by the authors/maintainers of this model. Please consult the source file and/or contact the author for more information. For general guidance on using models, refer to the BioImage.IO Documentation"

This message would provide better guidance to users when custom documentation is missing.

[FynnBe]

My hunch that there is a default at work was only partially correct; the documentation field is mandatory and has no default value, but as @mariana-gferreira pointed out to me the models in questions were created on the basis of the example notebook load_model_and_create_your_own.ipynb, which uses the spec README.md as a placeholder...
So there is no issue with the library, but the individual models need to be updated by their maintainers.

To avoid this from happening again I'll put a comment in the example notebook.