phys2bids icon indicating copy to clipboard operation
phys2bids copied to clipboard

Remove redundant files in docs and discuss general reconfiguration

Open sangfrois opened this issue 3 years ago • 5 comments

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 became physiopy/docs/community/CODE_OF_CONDUCT.md
  • phys2bids/docs/contributorfile.rsr became physiopy/docs/community/contributorfile.md
  • phys2bids/docs/bestpractices.rst became physiopy/docs/community/best-practices.md

Outstanding questions

  • What else do we want to move to physiopy.github.io ?

sangfrois avatar Nov 13 '20 20:11 sangfrois

What about phys2bids/docs/contributing.rsr ?

Maybe the "why use BIDS?" one too?

What do you think @RayStick @smoia ?

eurunuela avatar Nov 17 '20 11:11 eurunuela

Definitely contributing.rst, but I would keep "why use BIDS" here for the moment. If/when we expand it, we can change it.

smoia avatar Nov 17 '20 12:11 smoia

@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?

sangfrois avatar Nov 17 '20 18:11 sangfrois

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?

smoia avatar Nov 17 '20 19:11 smoia

For the rest, that's our general contribution guidelines, so it should be very much package unspecific and in physiopy.github.io!

smoia avatar Nov 17 '20 19:11 smoia