-
Notifications
You must be signed in to change notification settings - Fork 95
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
Reorganize RTD tree #677
Comments
Pinging in @dowdlelt and @mvaziri since they led the last documentation sprint :) This looks good to me @tsalo , thanks for proposing it ! My only immediate thought :
The phrasing makes me think that there's an alternative, but since we explicitly rule out a GUI I'm not sure what that would be... |
People can use tedana with the Python functions. I generally go that way when I'm testing things/debugging. EDIT: I just don't want to treat the API as an after-thought, which I think our current structure does. |
I like the change from tedana pipeline - because once we get another method, is as easy as making that "approaches" and adding subsections. I suppose one concern is that tedana outputs may become dependent on the denoising approach used - but that is bridge in the far distance, and I don't think we need to change things now. Moving processing out is good - better to break the connection between MEICA handling preprocessing and tedana not helping with that. I also think installing from github source is useful, per our discussions of release delays - this is how you can be sure to be using most recent versions and helps with answering questions. Our response can now be, see here to install the most recent version, rather than, we will release that fix "soon" (TM). |
Ah I see ! Sorry, I think I'm thinking in a very user-focused mindset when I look at this, and I don't know that everyone will distinguish between "command line" and "python prompt in terminal." They're different, of course, but I don't know that we should expect everyone to think of that. Not a strong feeling, though ! I definitely agree that the API currently comes off as a bit of an after-thought, which we should fix ! |
Summary
I think our current sidebar/organization is a little suboptimal, so I'd like to restructure it a bit. I've opened this issue so we could discuss my idea.
Additional Detail
Here's my proposal (happy to amend):
The text was updated successfully, but these errors were encountered: