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

multiple docs updates #55

Merged
merged 1 commit into from
Jun 26, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion docs/funding.rst
Original file line number Diff line number Diff line change
@@ -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 <https://chanzuckerberg.com/science/programs-resources/imaging/napari/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 <https://chanzuckerberg.com/science/programs-resources/imaging/napari/enabling-access-to-multi-resolution-data/>`_
and the napari Ecosystem Grants project, `Bridging Domains and Communities <https://chanzuckerberg.com/science/programs-resources/imaging/napari/bridging-domains-and-communities/>`_.
12 changes: 12 additions & 0 deletions docs/help.rst
Original file line number Diff line number Diff line change
@@ -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 <https://github.com/data-exp-lab/yt-napari/issues/new?assignees=&labels=&projects=&template=bug-report.md&title=>`_ when
encountering errors or a `github discussion issue <https://github.com/data-exp-lab/yt-napari/issues/new?assignees=&labels=&projects=&template=feedback-and-discussion.md&title=>`_ to ask a
question.

2. Join the yt slack! Follow instructions over at `<https://yt-project.org/community.html>`_ 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.
2 changes: 2 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,9 @@ Welcome to yt-napari's documentation!

installation
quickstart
help
notebooks
tutorials
schema
funding
source/modules
Expand Down
2 changes: 1 addition & 1 deletion docs/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://yt-project.org/doc/reference/configuration.html>`_ ). To add
on `configuration <https://yt-project.org/doc/reference/configuration.html>`_ ). 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:

Expand Down
14 changes: 14 additions & 0 deletions docs/tutorials.rst
Original file line number Diff line number Diff line change
@@ -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 <https://youtu.be/tNdIetamf98>`_
2. Tour of the yt-napari plugin: `link <https://youtu.be/ta7rBOYNpmg>`_

You can also find all of the above videos in `this youtube playlist <https://www.youtube.com/playlist?list=PLqbhAmYZU5KxuAcnNBIxyBkivUEiKswq1>`_.

Future tutorials are currently being tracked on github `Issue #40 <https://github.com/data-exp-lab/yt-napari/issues/40>`_. Feel free to comment there if
there is something in particular you'd like to see!