diff --git a/README.md b/README.md index 20125d83..5a7505a0 100644 --- a/README.md +++ b/README.md @@ -43,7 +43,7 @@ We also created a [shared spreadsheet](https://docs.google.com/spreadsheets/d/1F - :snake: :package: `narps_open/` contains the Python package with all the pipelines logic. - :brain: `data/` contains data that is used by the pipelines, as well as the (intermediate or final) results data. Instructions to download data are available in [INSTALL.md](/INSTALL.md#data-download-instructions). -- :blue_book: `docs/` contains the documentation for the project. Start browsing it with the entry point [docs/README.md](/docs/README.md) +- :blue_book: `docs/` contains the documentation for the project. Start browsing it [here](/docs/README.md) ! - :orange_book: `examples/` contains notebooks examples to launch of the reproduced pipelines. - :microscope: `tests/` contains the tests of the narps_open package. diff --git a/docs/README.md b/docs/README.md index f2c9a77e..55112428 100644 --- a/docs/README.md +++ b/docs/README.md @@ -3,15 +3,15 @@ :mega: This is the starting point for the documentation of the NARPS open pipelines project. ## Use the project -* :brain: [data](/docs/data.md) - handle the data needed by the project -* :hammer_and_wrench: [environment](/docs/environment.md) - handle the software environment needed by the project -* :rocket: [running](/docs/running.md) - launch pipelines in NARPS open pipelines +* :brain: [data](/docs/data.md) - handle the needed data +* :hammer_and_wrench: [environment](/docs/environment.md) - handle the software environment +* :rocket: [running](/docs/running.md) - launch pipelines ## Contribute to the code * :goggles: [description](/docs/description.md) - conveniently access descriptions of the pipelines, as written by the teams involved in NARPS. * :writing_hand: [pipeline](/docs/pipelines.md) - how to write pipelines. +* :microscope: [testing](/docs/testing.md) - testing features of the project, i.e.: how is the code tested ? -## Main +## For maintainers * :vertical_traffic_light: [status](/docs/status.md) - work progress status for a pipeline. -* :microscope: [testing](/docs/testing.md) - testing features of the project, i.e.: how is the code tested ? * :package: [ci-cd](/docs/ci-cd.md) - how continuous integration and delivery (knowned as CI/CD) is set up.