Skip to content

Commit

Permalink
Merge branch 'add_community_section' of github.com:neuroinformatics-u…
Browse files Browse the repository at this point in the history
…nit/datashuttle into add_community_section
  • Loading branch information
JoeZiminski committed May 16, 2024
2 parents 2f29ab3 + 05b7739 commit 34150d9
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 7 deletions.
5 changes: 4 additions & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 0 additions & 1 deletion docs/source/pages/community/community.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@ our [Guiding Principles](guiding-principles.md) and [Roadmap](roadmap.md).

```{toctree}
:maxdepth: 2
:caption: index
:hidden:
contributing
Expand Down
4 changes: 2 additions & 2 deletions docs/source/pages/community/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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)
8 changes: 5 additions & 3 deletions docs/source/pages/community/guiding-principles.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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
Expand Down

0 comments on commit 34150d9

Please sign in to comment.