This repository hosts the documentation and support website for BrainSTEM.org. BrainSTEM is a collaborative electronic lab notebook for FAIR data sharing in neuroscience research. The website provides comprehensive documentation of the BrainSTEM platform: the data model, the web interface, the API and API tools, tutorials, and the public data-sharing portal.
You can view the documentation and support website at support.brainstem.org.
The documentation is built using the Just the Docs Jekyll theme, which offers a clean, minimalistic design with easy navigation and search functionality.
We encourage dialog, feedback, and contributions to improve BrainSTEM and the documentation and tutorials. Please use the following systems for collaboration:
- Issues: Report bugs, suggest improvements, or request new documentation content.
- Discussions: Engage with the community, ask questions, or propose ideas for the platform.
To run the documentation site locally:
- Clone this repository:
git clone https://github.com/brainstem-org/brainstem_support.git
- Navigate into the docs directory:
cd brainstem_support/docs - Install Jekyll and dependencies:
bundle install
- Serve the site locally:
bundle exec jekyll serve - Access the local site at
http://localhost:4000.
This documentation is released under the MIT License.