diff --git a/docs/funding.rst b/docs/funding.rst index 8899f92..70d66fe 100644 --- a/docs/funding.rst +++ b/docs/funding.rst @@ -1,4 +1,6 @@ Funding ======= -The yt-napari plugin project was funded with support from the Chan Zuckerberg Initiative through the napari Plugin Accelerator Grants project, `Enabling Access To Multi-resolution Data `_. +The yt-napari plugin project was funded with support from the Chan Zuckerberg Initiative +through the napari Plugin Accelerator Grants project, `Enabling Access To Multi-resolution Data `_ +and the napari Ecosystem Grants project, `Bridging Domains and Communities `_. diff --git a/docs/help.rst b/docs/help.rst new file mode 100644 index 0000000..e7f3a9a --- /dev/null +++ b/docs/help.rst @@ -0,0 +1,12 @@ +Getting Help +############ + +There are a couple of ways to get help with using :code:`yt-napari`: + +1. Open a `github bug report `_ when +encountering errors or a `github discussion issue `_ to ask a +question. + +2. Join the yt slack! Follow instructions over at ``_ to join the yt slack and +then add yourself to the :code:`#yt-napari` channel and ask away! This is also where :code:`yt-napari` announcments get posted +when they don't warrant a larger :code:`yt-user` announcement. diff --git a/docs/index.rst b/docs/index.rst index cc72db2..8a2d09b 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -14,7 +14,9 @@ Welcome to yt-napari's documentation! installation quickstart + help notebooks + tutorials schema funding source/modules diff --git a/docs/quickstart.rst b/docs/quickstart.rst index 8f75273..032a0f3 100644 --- a/docs/quickstart.rst +++ b/docs/quickstart.rst @@ -104,7 +104,7 @@ Configuring yt-napari User options can be saved between napari sessions by adding to the base :code:`yt` configuration file, :code:`yt.toml`. :code:`yt` looks for the configuration file in a number of places (check out the :code:`yt` documentation -on:ref:`configuration `_ ). To add +on `configuration `_ ). To add :code:`yt-napari` options, open up (or create) the configuration file and add a :code:`[yt_napari]` section. An example configuration file might look like: diff --git a/docs/tutorials.rst b/docs/tutorials.rst new file mode 100644 index 0000000..a83c040 --- /dev/null +++ b/docs/tutorials.rst @@ -0,0 +1,14 @@ +Tutorial Series +############### + +The :code:`yt-napari` Video Tutorial Series provides a more interactvie way to get started using :code:`yt-napari`! + +The following videos are now available: + +1. Intro to napari for yt users: `link `_ +2. Tour of the yt-napari plugin: `link `_ + +You can also find all of the above videos in `this youtube playlist `_. + +Future tutorials are currently being tracked on github `Issue #40 `_. Feel free to comment there if +there is something in particular you'd like to see!