From 0800b146126f9225bc3a2d3a9abbab0bd1a674df Mon Sep 17 00:00:00 2001 From: Heberto Mayorquin Date: Wed, 17 Apr 2024 17:09:24 -0600 Subject: [PATCH] Add an introductory section on "how to use the documentation" to the read the docs landing page (#730) Co-authored-by: Paul Adkisson Co-authored-by: Cody Baker <51133164+CodyCBakerPhD@users.noreply.github.com> --- docs/index.rst | 54 ++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 52 insertions(+), 2 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index 70a557dab..e6fb8788b 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -19,9 +19,42 @@ Features: * Minimizes the size of the NWB files by automatically applying chunking and lossless compression. * Supports ensembles of multiple data streams, and supports common methods for temporal alignment of streams. -.. seealso:: - Watch a video introduction to NeuroConv `here `_ + +How to use the documentation +---------------------------- + +Our documentation is structured to cater to users ranging from beginners to advanced developers and contributors. +Below is an overview of the key sections to help you navigate our documentation effectively + +* **Getting Started: Conversion Examples Gallery** + + If you're new to NeuroConv or NWB, start with the `Conversion Examples Gallery `_. + This section provides concise scripts for converting data from common formats (e.g., Blackrock, Plexon, Neuralynx) to NWB. It's designed to get you up and running quickly. + +* **User Guide** + + The `User Guide `_ offers a comprehensive overview of NeuroConv's data model and functionalities. + It is recommended for users who wish to understand the underlying concepts and extend their scripts beyond basic conversions. + +* **Catalogue of Projects** + + `The Catalogue of Neuroconv Projects `_ section showcases a collection of successful conversion projects utilizing NeuroConv. + It serves as both inspiration and a practical reference for what can be achieved with our library. + +* **Developer Guide** + + For developers interested in contributing to NeuroConv, the `Developer Guide `_ provides essential information such as + instructions for building your own classes, our coding style, instructions on how to build the documentation, + run the testing suite, etc. + +* **API Reference** + + Detailed documentation of the NeuroConv API can be found in the `API `_ section. + + +Do you find that some information is missing or some section lacking or unclear? Reach out with an issue or pull request on our `GitHub repository `_. +We are happy to help and appreciate your feedback. .. toctree:: :maxdepth: 2 @@ -33,10 +66,27 @@ Features: developer_guide api + +Related links +------------- + + +For an overview of the NWB standard and ecocsystem, please view: + +- The `NWB Overview `_ + +For a no code solution to conversion to NWB, please view: + +- The `NWB-Guide Project `_ + For more information regarding the NWB Standard, please view - The `NWB Format Specification `_ +.. seealso:: + + Watch a video introduction to NeuroConv `here `_ + .. Indices and tables .. ================== ..