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

Add Examples and Documentation #15

Open
akimbler opened this issue Mar 30, 2020 · 2 comments
Open

Add Examples and Documentation #15

akimbler opened this issue Mar 30, 2020 · 2 comments

Comments

@akimbler
Copy link
Member

See Title

@tsalo
Copy link
Member

tsalo commented Mar 31, 2020

How do you want to set this up? I think examples are relatively limited, so they could probably just go in the README, but if we want to be extensive in our documentation we could set things up to build with Sphinx and have an RTD site.

Also, do we want to centralize documentation of cis-bidsify, cis-processing, and cis-xget under cis-processing (either in the README, RTD, or the wiki)?

@akimbler
Copy link
Member Author

akimbler commented Apr 1, 2020

I think having an example run in the README works perfectly fine for the individual cis-xget and cis-bidsify repos. Working on centralizing them under cis-processing seems like the best option for now, I agree. I just want some barebones documentation on each repo just for use cases where the user isn't wanting to work with cis-processing in its entirety

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

No branches or pull requests

2 participants