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

Updating the documentation #125

Merged
merged 13 commits into from
Nov 14, 2023
Merged

Updating the documentation #125

merged 13 commits into from
Nov 14, 2023

Conversation

cmaumet
Copy link
Contributor

@cmaumet cmaumet commented Nov 7, 2023

This Pull Request is related to issue [#](add a link to the issue here).

Changes proposed in this Pull Request:

  • Shorten the README
  • Add two trails in the CONYRIBUTING document (nipype expert versus fMRI software expert)

Checklist:

  • Descriptive title
  • Targets the main branch
  • Changes are functional
  • [NA] My code is explicit and comments were added to it
  • [NA] Code conforms with PEP8
  • [NA] Tests were added for the changes and they complete successfully
  • [NA] Existing tests were updated (if needed) and they complete successfully
  • Documentation was updated

To be done:

  • fmri software trail is currently empty
  • we need a quick example of how to use the team description module

@cmaumet cmaumet requested a review from bclenet November 9, 2023 11:00
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
CONTENT.md Outdated
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we should not create this file for now, until we have a place for the dev documentation ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Happy to do as you think is best. Can you remind me where the dev documentation is located so that I can move these?

CONTRIBUTING.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
@cmaumet
Copy link
Contributor Author

cmaumet commented Nov 13, 2023

@bclenet Thanks for the review! I've updated following your comments. If you can check my reply to the comments above and let me know if all is good before we merge?

@bclenet bclenet merged commit 93bb718 into Inria-Empenn:main Nov 14, 2023
1 check passed
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

Successfully merging this pull request may close these issues.

2 participants