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.

Sign up for GitHub

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

Jump to bottom

Add user documentation #12

Closed
smoia opened this issue Oct 2, 2019 · 3 comments
Closed

Add user documentation #12

smoia opened this issue Oct 2, 2019 · 3 comments
Labels
Documentation This issue or PR is about the documentation
Milestone
phys2bids first n...

Comments

@smoia
Copy link
Member

smoia commented Oct 2, 2019

The library needs a readthedocs with explanations on usage, bids format and physio files.
@smoia smoia added the Documentation This issue or PR is about the documentation label Oct 2, 2019
@smoia smoia added this to the phys2bids 1.0.0 milestone Oct 2, 2019
@smoia
Copy link
Member Author

smoia commented Nov 11, 2019 •
edited
Loading

Our documentation could contain:

  • An obvious "how do I use this program" section
  • A less obvious "Why BIDS"
  • A quite interesting "Hey there's this thing called physiological activity you might want to consider when you do neuroimaging"

@rmarkello rmarkello mentioned this issue Nov 12, 2019
Merged
@smoia smoia mentioned this issue Nov 28, 2019
Closed
3 tasks
@smoia smoia mentioned this issue Jan 7, 2020
Merged
@AyyagariA AyyagariA mentioned this issue Mar 26, 2020
Merged
@smoia
Copy link
Member Author

smoia commented Apr 1, 2020

It would be great if someone could write a short "Why BIDS" section for our documentation: explaining what is BIDS and why should we be using it. Nothing big, half a page would be enough.

This was referenced Apr 2, 2020
Merged
Merged
@smoia smoia mentioned this issue Apr 5, 2020
Closed
@smoia
Copy link
Member Author

smoia commented Jun 8, 2020

This issue was closed by #229

@smoia smoia closed this as completed Jun 8, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Documentation This issue or PR is about the documentation
Projects
None yet
Milestone
phys2bids first non-beta
Development

No branches or pull requests
1 participant
@smoia