catalystneuro/neuroconv

[Documentation]: Minor suggestions for Docker docs

Opened this issue · 0 comments

What would you like changed or added to the documentation and why?

I was looking at https://neuroconv.readthedocs.io/en/main/user_guide/docker_demo.html and just have a couple of minor suggestions:

  • In the section NeuroConv Docker Demo section it would be nice to add links to the related sections in the docs to make it easier for a reader that may start on this page to find the resources to learn how to customize the demo for their needs. In particular:
  • In the section RClone With Config Docker Demo the text is referring to a special docker image to use, but it wasn't clear from the text what that image is. It wasn't until I looked at the docker command in more detail that I realized that the text is probably referring to ghcr.io/catalystneuro/rclone_with_config:latest but the docker command is long so a reader doesn't see this part unless they scroll all the way to right on the command. It would be useful to update the first sentence "NeuroConv also supports a convenient Docker image for running data transfers " to add a link to https://github.com/catalystneuro/neuroconv/pkgs/container/rclone_with_config

Do you have any interest in helping write or edit the documentation?

No.

Code of Conduct