Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Documentation]: Minor suggestions for Docker docs #1101

Open
2 tasks done
oruebel opened this issue Sep 28, 2024 · 0 comments
Open
2 tasks done

[Documentation]: Minor suggestions for Docker docs #1101

oruebel opened this issue Sep 28, 2024 · 0 comments

Comments

@oruebel
Copy link

oruebel commented Sep 28, 2024

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant