Skip to content

Commit

Permalink
try to add note to Overview page
Browse files Browse the repository at this point in the history
  • Loading branch information
michellewang committed May 7, 2024
1 parent 97ee1fe commit 9c3f21e
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 0 deletions.
9 changes: 9 additions & 0 deletions docs/nipoppy/cli_note.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
!!! note

Nipoppy is undergoing a major refactor to move from scripts to a
command-line interface (CLI) and Python API. The new documentation website
(work in progress) can be found at [nipoppy.readthedocs.io](nipoppy.readthedocs.io).

If you are using the (soon-to-be legacy) scripts from Nipoppy 0.1.0, this is
still the correct place to be. But we encourage you to check out the new
website!
4 changes: 4 additions & 0 deletions docs/nipoppy/overview.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
{%
include-markdown "cli_note.md"
%}

## What is Nipoppy?

[Nipoppy](https://github.com/neurodatascience/nipoppy) is a lightweight framework for analyzing (neuro)imaging and clinical data. It is designed to help users do the following:
Expand Down

0 comments on commit 9c3f21e

Please sign in to comment.