Skip to content

Commit c2de000

Browse files
committed
Revise and expand BrainSTEM documentation pages
Updated index.md to clarify site purpose, community involvement, and support options. Expanded webinterface.md with new sections for Import Tool and Two-Factor Authentication. Significantly enhanced dashboard.md and user-profile.md with detailed component descriptions, navigation tips, and role explanations to improve user onboarding and understanding of platform features.
1 parent a8ccbea commit c2de000

4 files changed

Lines changed: 172 additions & 29 deletions

File tree

docs/index.md

Lines changed: 19 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -6,21 +6,23 @@ has_children: false
66
has_toc: false
77
---
88

9-
# BrainSTEM Documentation
9+
# BrainSTEM Documentation & Support
1010
{: .no_toc}
1111
{: .fs-9 }
1212

13-
A collaborative electronic lab notebook for experimental neuroscience.
13+
Documentation, tutorials, and support resources for BrainSTEM.
1414
{: .fs-6 .fw-300}
1515

1616
[Get started now](#getting-started){: .btn .btn-primary .fs-5 .mb-4 .mb-md-0 .mr-2} [Visit BrainSTEM.org](https://www.brainstem.org/){: .btn .fs-5 .mb-4 .mb-md-0}
1717

1818
![website screenshot](/assets/images/website_screenshot_v2.jpg)
1919

20-
## Introduction
20+
## About BrainSTEM
2121
{: .no_toc}
2222

23-
BrainSTEM (Brain Structured Experimental Metadata) is a collaborative electronic lab notebook designed specifically for experimental neuroscience. It captures and organizes a comprehensive range of electrophysiological, imaging, and behavioral data through a modular, standardized data model that can be extended to accommodate future data types.
23+
This site provides comprehensive documentation and support for BrainSTEM (Brain Structured Experimental Metadata) – a collaborative electronic lab notebook designed specifically for experimental neuroscience. BrainSTEM captures and organizes electrophysiological, imaging, and behavioral data through a modular, standardized data model that can be extended to accommodate future data types.
24+
25+
Whether you're running a small lab or managing large-scale collaborative projects, BrainSTEM provides the infrastructure to organize, share, and access your experimental data with standardized metadata and reproducible workflows.
2426

2527
### Key Features
2628

@@ -31,7 +33,7 @@ BrainSTEM (Brain Structured Experimental Metadata) is a collaborative electronic
3133
- **Customizable Interface**: Web-based interface tailored for neuroscience research workflows
3234
- **Standardized Metadata**: Consistent data annotation using controlled vocabularies and taxonomies
3335

34-
BrainSTEM is ready for public use, and encourage researchers to create an account and begin exploring the platform. Your feedback helps us advance and shape the future of collaborative neuroscience data management.
36+
BrainSTEM is ready for public use, and we encourage researchers to create an account and begin exploring the platform. Your feedback helps us advance and shape the future of collaborative neuroscience data management.
3537

3638
[Data Model]({{"/datamodel/"|absolute_url}}){: .btn .fs-5 .mb-4 .mb-md-0 .mr-4} [Web Interface]({{"/webinterface/"|absolute_url}}){: .btn .fs-5 .mb-4 .mb-md-0 .mr-4} [API]({{"/api/"|absolute_url}}){: .btn .fs-5 .mb-4 .mb-md-0 .mr-4} [API Tools]({{"/api-tools/"|absolute_url}}){: .btn .fs-5 .mb-4 .mb-md-0 .mr-4}
3739

@@ -51,32 +53,33 @@ Explore advanced features including:
5153
- Public data sharing and collaboration
5254
- Resource and taxonomy submission
5355
- Project and group management
54-
- API integration for programmatic access
56+
- Setting up lab infrastructure
5557

5658
[Get Started Tutorial]({{ "/tutorials/get_started/"|absolute_url}}){: .btn .btn-primary .fs-5 .mb-4 .mb-md-0 .mr-2}
5759
[View All Tutorials]({{ "/tutorials/"|absolute_url}}){: .btn .fs-5 .mb-4 .mb-md-0 .mr-2}
5860

59-
## Join Our Pilot Program
61+
## Join Our Community
6062

61-
We're actively seeking research groups to participate in the BrainSTEM pilot program. As a pilot user, you'll help shape the future of collaborative neuroscience data management while gaining early notice of new features.
63+
We're actively seeking research groups to join the BrainSTEM community. As an active user, you'll help shape the future of collaborative neuroscience data management while gaining early notice of new features.
6264

6365
### Benefits of Joining
64-
- **Early Access**: Get to know about new features and capabilities first
66+
- **Stay Informed**: Get early notice about new features and capabilities
6567
- **Direct Impact**: Your feedback directly influences platform development
66-
- **Collaborative Network**: Connect with other forward-thinking research groups
67-
- **Support**: Dedicated support during your onboarding and beyond
68+
- **Dedicated Support**: Assistance during onboarding and beyond
6869

69-
If you're committed to advancing open science and interested in becoming a pilot user, we'd love to hear from you.
70+
If you're committed to advancing open science and interested in joining the BrainSTEM community, we'd love to hear from you.
7071

71-
[Join Pilot Program](https://docs.google.com/forms/d/e/1FAIpQLSctFj4ek5Ib-1FQoi9KeGzCkg6o-cuM26oggNu8FYeKRqNpwg/viewform){: .btn .btn-primary .fs-5 .mb-4 .mb-md-0}
72+
[Join the Community](https://docs.google.com/forms/d/e/1FAIpQLSctFj4ek5Ib-1FQoi9KeGzCkg6o-cuM26oggNu8FYeKRqNpwg/viewform){: .btn .btn-primary .fs-5 .mb-4 .mb-md-0}
7273

7374
## Support and Community
7475

7576
### Get Help
76-
For technical support, bug reports, and feature requests:
77+
We're here to assist you with any questions or issues:
78+
79+
- **[GitHub Issues](https://github.com/brainstem-org/brainstem_support/issues)**: Report bugs and technical problems
80+
- **[GitHub Discussions](https://github.com/brainstem-org/brainstem_support/discussions)**: Ask questions, request features, and engage with the community
81+
- **[Contact Form](https://brainstem.org/#Get-in-touch)**: For account-specific issues and direct support
7782

78-
- **[GitHub Issues](https://github.com/brainstem-org/brainstem_support/issues)**: Report bugs and technical issues
79-
- **[GitHub Discussions](https://github.com/brainstem-org/brainstem_support/discussions)**: General questions, feature requests, and community discussion
8083

8184
### Contributing
8285
BrainSTEM thrives on community input. Whether you're reporting bugs, suggesting enhancements, or participating in discussions, your contribution helps improve the platform for all users.

docs/webinterface.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,5 +17,7 @@ The interface consists of several main components:
1717
- [__List Views__]({{"webinterface/list-view"|absolute_url}}): Table views showing individual models with flexible sorting and filtering
1818
- [__Single Entry Views__]({{"webinterface/single-entry-view"|absolute_url}}): Detailed pages showing comprehensive information about specific entries
1919
- [__User Profile__]({{"webinterface/user-profile"|absolute_url}}): Personal settings and preferences
20+
- [__Import Tool__]({{"webinterface/import-tool"|absolute_url}}): Bulk data import using CSV templates
21+
- [__Two-Factor Authentication__]({{"webinterface/two-factor-authentication"|absolute_url}}): Enhanced account security setup
2022

2123
Each of these components is described in detail in the following sections.

docs/webinterface/dashboard.md

Lines changed: 70 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,77 @@ nav_order: 1
66
---
77

88
# Dashboard
9+
{: .no_toc}
910

10-
The dashboard provides an overview of your research data in BrainSTEM, displaying:
11+
## Overview
1112

12-
- __Projects__: Your recent projects with total project count
13-
- __Subjects__: Recently added or modified subjects
14-
- __Sessions__: Your most recent sessions
15-
- __Cohorts__: Recent subject cohorts
16-
- __Collections__: Recent session collections
17-
- __Strain Statistics__: Most commonly used strains
18-
- __Consumable Statistics__: Most commonly used consumables
13+
The dashboard is your landing page in BrainSTEM, providing quick access to your recent research activity and frequently used resources. Click on any item to navigate to its detail page.
1914

2015
![dashboard_v2](/assets/images/dashboard_v2.png)
21-
*The BrainSTEM dashboard interface*
16+
*The BrainSTEM dashboard interface*
17+
18+
## Dashboard Components
19+
20+
### Projects
21+
22+
Shows your most recently edited projects.
23+
24+
- Click on **project names** to navigate to project details
25+
- View **total count** of projects you can access
26+
27+
### Subjects
28+
29+
Displays recently edited subjects.
30+
31+
- Click on **subject names** to view full details and history
32+
- Check **last modified** date to track recent updates
33+
34+
### Sessions
35+
36+
Shows your most recent experimental sessions for immediate access to ongoing work.
37+
38+
- Click on **session names** to view full session details
39+
- Check **last modified** date to track recent updates
40+
41+
### Cohorts
42+
43+
Lists recently created subject cohorts (groups of subjects with shared characteristics).
44+
45+
- Click on **cohort names** to see member subjects
46+
- Useful for organizing treatment groups, littermates, or subjects by experimental condition
47+
48+
### Collections
49+
50+
Displays recent session collections (groups of related sessions).
51+
52+
- Click on **collection names** to view included sessions
53+
- Useful for accessing multi-day experiments or related session groups
54+
55+
### Statistics
56+
57+
#### Strain Statistics
58+
{: .no_toc}
59+
60+
The most commonly used animal strains across all users.
61+
62+
- View frequency of strain usage in your research
63+
- Click on strain names to filter and see all subjects of that strain
64+
- Useful for colony management and planning breeding strategies
65+
66+
#### Consumable Statistics
67+
{: .no_toc}
68+
69+
The most frequently used consumables (probes, drugs, viruses, etc.).
70+
71+
#### Hardware device statistics
72+
{: .no_toc}
73+
74+
The most frequently used Hardware devices (data acquisition devices, cameras, surgical equipment, etc.).
75+
76+
## Navigation Tips
77+
78+
- Click any item name to view its detail page
79+
- Hover over items to see quick action options
80+
- Use the search bar (top right) to find specific entries
81+
- Use the left sidebar navigation for full list views
82+
- Filter data by project using the project dropdown

docs/webinterface/user-profile.md

Lines changed: 81 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,85 @@ nav_order: 5
88
# User profile
99
{: .no_toc}
1010

11-
The user profile page shows:
11+
## Overview
1212

13-
- __Personal details__: View and edit your information
14-
- __Groups__: Overview of your group memberships
15-
- __Projects__: List of your projects and their permissions
13+
The user profile page is your personal hub in BrainSTEM, displaying your account information, affiliations, and access permissions. You can access your profile by clicking on your username in the top-right corner of any page and selecting **Profile**.
14+
15+
## Personal Details
16+
17+
View and edit your personal information to keep your profile up to date and help collaborators identify you within BrainSTEM.
18+
19+
| Field | Description |
20+
|-------|-------------|
21+
| **Name** | Your full name displayed throughout BrainSTEM |
22+
| **Email** | Primary contact email and login identifier |
23+
| **ORCID** | Link to your ORCID profile |
24+
| **Google Scholar** | Link to your google Scholar profile |
25+
| **Website** | Link to your website |
26+
| **Profile Picture** | Avatar displayed next to your contributions |
27+
28+
### How to Edit Your Profile
29+
{: .no_toc}
30+
31+
1. Click on your username in the top-right corner
32+
2. Select **Profile** from the dropdown menu
33+
3. Click the **Edit** button next to the section you want to modify
34+
4. Make your changes and click **Save**
35+
5. Verify any email changes by clicking the confirmation link sent to your new address
36+
37+
{: .note }
38+
> Updating your profile information helps collaborators find and recognize you when working on shared projects. A complete profile with ORCID linking also ensures proper attribution for your contributions.
39+
40+
## Group Memberships
41+
42+
This section displays all groups you belong to, helping you understand your organizational affiliations and permissions.
43+
44+
| Information Displayed | Purpose |
45+
|----------------------|---------|
46+
| **Group Name** | The laboratory or organizational group you're part of |
47+
| **Membership Roles** | Your role within the group (Manager, Owner) |
48+
49+
{: .note }
50+
> The Group memberships list is a private list, but other users can see your group memberships from the list of groups.
51+
52+
### Understanding Your Group Membership Roles
53+
{: .no_toc}
54+
55+
- **Member**: Can view and edit group data based on assigned permissions
56+
- **Manager**: Can manage members and their permissions
57+
- **Owner**: Full control over group and members
58+
59+
{: .important }
60+
> If you need different permissions within a group, contact the group owner or manager. You can find their contact information by clicking on the group name.
61+
62+
{: .note }
63+
> The Project memberships list is a private list, and other users cannot see your project memberships, besides any shared projects.
64+
65+
## Project Permissions
66+
67+
View all projects you have access to and understand your permissions for each project.
68+
69+
| Column | Description |
70+
|--------|------------|
71+
| **Project Name** | Name of the research project |
72+
| **Membership Roles** | Any additional permissions (Create, Manager, Owner) |
73+
74+
### Project Membership Roles Explained
75+
{: .no_toc}
76+
77+
| Permission | What You Can Do |
78+
|------------|-----------------|
79+
| **Member** | Browse project data, sessions, and subjects |
80+
| **Create** | View and modify existing entries, add new data |
81+
| **Manager** | Manage project memberships |
82+
| **Owner** | Full control of the project |
83+
84+
## Account Settings
85+
86+
Additional account management options available from your profile:
87+
88+
- **Two-Factor Authentication**: Enable 2FA for enhanced account security
89+
- **API Tokens**: Generate personal access tokens for programmatic access
90+
91+
{: .warning }
92+
> Keep your email address up to date to ensure you receive important notifications about data changes, permission updates, and system announcements.

0 commit comments

Comments
 (0)