Closed seankmartin closed 1 year ago
Hi @seankmartin, do you remember we talked about the README DESCRIPTION problem. Was there some movement on your side? Is it still needed to keep the same information in both files for rendering on git / pip and napari hub? I have some time at the moment and would like to update some things.
Best, Chris
Hi @Chris-N-K!
All sorted on our end now, thanks. You do not need to keep the same information in both the README and DESCRIPTION.
Writing a DESCRIPTION file allows you to make a napari hub specific version of your plugin information. If you want to make a DESCRIPTION file for that purpose, then cool, otherwise you can leave the information in the README and the hub will render it as before
Cheers! Sean
Thanks for the reply, sounds good :)
Hi again,
I'm Sean, and I created this issue to complement #23.
While scanning your repository, I identified some metadata that are either missing, or misplaced in files that are considered as secondary or deprecated sources.
Since metadata sometimes is hard to fix automatically I created a list of what improvements you might want to look into to improve the overall quality of your napari hub listing:
'Screenshot/Video' entry was not found (scanned files:
.napari\DESCRIPTION.md
,README.md
,pyproject.toml
)'Intro Paragraph' entry was not found (scanned files:
.napari\DESCRIPTION.md
,README.md
,pyproject.toml
)Usage Overview was found in
README.md
, but it is preferred to place this information in.napari\DESCRIPTION.md
Installation was found in
README.md
, but it is preferred to place this information in.napari\DESCRIPTION.md
If you need, here are more details about metadata and their locations.
As I mentioned in my PR, if some metadata is already present and I overlooked it, please feel free to contact me or neuromusic to tell us what could be improved!
Thank you for your help and feedback,
The napari hub and MetaCell teams.