diff --git a/docs/source/conf.py b/docs/source/conf.py index c8e4c883..9411f562 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -121,7 +121,10 @@ html_favicon = "_static/logo_light.png" html_sidebars = { - "**": [] + "pages/how_tos/*": [], + "pages/tutorials/*": [], + "pages/tutorials": [], + "pages/how_tos": [], } # Customize the theme diff --git a/docs/source/pages/community/community.md b/docs/source/pages/community/community.md index f7402ef8..b63066ae 100644 --- a/docs/source/pages/community/community.md +++ b/docs/source/pages/community/community.md @@ -21,7 +21,6 @@ our [Guiding Principles](guiding-principles.md) and [Roadmap](roadmap.md). ```{toctree} :maxdepth: 2 -:caption: index :hidden: contributing diff --git a/docs/source/pages/community/contributing.md b/docs/source/pages/community/contributing.md index 2ce2b785..7cc946a1 100644 --- a/docs/source/pages/community/contributing.md +++ b/docs/source/pages/community/contributing.md @@ -13,7 +13,7 @@ The core development team will support you in contributing code, regardless of y ## Creating a development environment For detailed instructions on installing **datashuttle** along with -all necessary packages for development, refer to the 'Developers' tab on the +all necessary packages for development, refer to the `Developers` tab on the [How to install **datashuttle**](how-to-install) page. Briefly, after installing Rclone, the **datashuttle** repository can be cloned: @@ -165,4 +165,4 @@ To edit a page, please: - Create a pull request outlining the changes made If you aren't sure where the changes should be made, please -[get in touch!](https://neuroinformatics.zulipchat.com/#narrow/stream/405999-DataShuttle). +[get in touch!](https://neuroinformatics.zulipchat.com/#narrow/stream/405999-DataShuttle) diff --git a/docs/source/pages/community/guiding-principles.md b/docs/source/pages/community/guiding-principles.md index aff9c669..90d3ed03 100644 --- a/docs/source/pages/community/guiding-principles.md +++ b/docs/source/pages/community/guiding-principles.md @@ -18,8 +18,10 @@ and **datashuttle** are: [BIDS](https://bids.neuroimaging.io/) and [NWB](https://www.nwb.org/) -are the gold-standard for standardising systems neuroscience projects. -Alignment with these specifications should always be the ultimate goal for any project. +are the most comprehensive community standards for systems neuroscience projects. +Adhering to these specifications ensures complete standardisation e.g. in metadata +and file formats. Though extremely valuable, full compliance with these standards +can be time-consuming and technically difficult. **NeuroBlueprint**'s role is to provide a lightweight standard that can be used to get started, especially during the early phase of a project when things may be very busy. @@ -38,7 +40,7 @@ as it develops such that it ends up duplicating BIDS in scope. In the initial versions (**datashuttle** v0.4, **NeuroBlueprint** v0.2), the goal is to have a simple organisational -system in which the raw data for different datatypes (ephys, behaviour) +system in which the raw data for different datatypes (e.g. ephys, behaviour) can be automatically discovered in any given project. In future versions it will be necessary to standardise additional features