phys2bids
phys2bids copied to clipboard
Remove redundant files in docs and discuss general reconfiguration
Reorganization of physiopy's documentation -> Removal of files in phys2bids
I have pushed a few changes on physiopy.github.io
PR#2. Essentially, we want to have a main website for the community that redirects the users to each package's readthedocs
page.
We don't want to be redundant, so THESE FILES HAVE TO BE DELETED from phys2bids
💯 :
-
phys2bids/docs/CODE_OF_CONDUCT.rst
becamephysiopy/docs/community/CODE_OF_CONDUCT.md
-
phys2bids/docs/contributorfile.rsr
becamephysiopy/docs/community/contributorfile.md
-
phys2bids/docs/bestpractices.rst
becamephysiopy/docs/community/best-practices.md
Outstanding questions
- What else do we want to move to
physiopy.github.io
?
What about phys2bids/docs/contributing.rsr
?
Maybe the "why use BIDS?" one too?
What do you think @RayStick @smoia ?
Definitely contributing.rst, but I would keep "why use BIDS" here for the moment. If/when we expand it, we can change it.
@smoia definitely would keep controbuting.rst
?
There were parts that seemed to be phys2bids specific... Am I correct in assuming this would have to be adapted if moved?
Ah, I see why you say so.
The only phys2bids
specific part I see is in the section Contributing with test files
- but it's actually not phys2bids
specific - we can change the sentence from:
The file contribution should come with a json file of the same name that contains the necessary information to run phys2bids on that file contribution.
To
The file contribution should come with a json file of the same name that contains the necessary information to run our packages on that file.
Is there anything else I'm missing?
For the rest, that's our general contribution guidelines, so it should be very much package unspecific and in physiopy.github.io
!