-
Notifications
You must be signed in to change notification settings - Fork 1
Add new tutorials and update existing guides #43
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Added new tutorials covering behavioral paradigms, electrophysiology workflow, managing data storage, setting up lab infrastructure, and two-photon imaging workflow. Updated existing tutorials to reference new guides, expanded instructions for personal attributes, group and project management, and API usage. These changes improve documentation coverage and provide step-by-step guidance for users on experimental setup, data management, and programmatic access.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This pull request significantly expands BrainSTEM's tutorial documentation by adding five new comprehensive tutorials and updating existing guides to provide better cross-referencing and expanded instructional content. The changes improve documentation coverage for experimental workflows, infrastructure setup, and data management.
- Added comprehensive tutorials for behavioral paradigms, electrophysiology workflow, data storage management, lab infrastructure setup, and two-photon imaging workflow
- Updated existing tutorials with expanded instructions for personal attributes, group/project management, and API usage
- Enhanced cross-referencing between tutorials with "Next Steps" sections linking related workflows
Reviewed Changes
Copilot reviewed 13 out of 13 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| docs/tutorials/two-photon-imaging-workflow.md | New comprehensive tutorial covering complete two-photon calcium imaging experiments from setup to analysis |
| docs/tutorials/setting-up-lab-infrastructure.md | New detailed guide for establishing lab foundations including setups, equipment, and inventories |
| docs/tutorials/managing-data-storage.md | New tutorial covering data storage configuration and dynamic linking for analysis workflows |
| docs/tutorials/electrophysiology-workflow.md | New complete workflow tutorial for electrophysiology experiments with spatial learning paradigms |
| docs/tutorials/behavioral-paradigms.md | New tutorial explaining behavioral paradigm creation and management |
| docs/tutorials/submit-resource-and-taxonomies.md | Updated with expanded guidelines and "Next Steps" section |
| docs/tutorials/sharing-project-publicly.md | Added "Next Steps" section linking to related tutorials |
| docs/tutorials/managing-projects.md | Added "Next Steps" section with workflow integration |
| docs/tutorials/managing-groups.md | Expanded content and added "Next Steps" section |
| docs/tutorials/python-api-tool.md | Enhanced with error handling, examples, and "Next Steps" |
| docs/tutorials/matlab-api-tool.md | Improved with troubleshooting and "Next Steps" section |
| docs/tutorials/get_started.md | Expanded personal attributes section with detailed instructions |
| docs/tutorials.md | Updated main tutorial index with new tutorial links |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
|
Hi Mingze Have you had time to review the new tutorials and fix the ephys tutorial? The 2p tutorial is not ready - I can continue working on it. |
|
Hi peter, I only reformatted the ephys md file, nothing is changed otherwise. I think the API tutorials could be improved a bit. I am working on it now. Also I am checking the updates we made recently, then to make sure our API tutorials are up-to-date. |
|
Hi Peter, I moved your API tools in tutorial section to api tools section since it's redundant to have 2 different tutorials. But I still left the tutorial files, directing to the api tools page. |
|
Hi Mingze, That's fine as long as they cover the same topics. I see you included a lot on the Python tool page, but the MATLAB API tool page doesn't cover the same content. If we proceed with this, I think we should simply remove the two empty tool tutorials and references to them. Furthermore, there are tutorials within the GitHub repositories that we could link to instead. |
|
Hi peter, you mean remove the api tools in tutorial? If you think it's redundant then of course we can delete it. (Because you put them in the tutorial I didn't know if it's intentional) I have added the link directing to api repo. And I think it would be a good idea to also have an md file with code block as what we made. So our users wont always have to go to the ipynb or m file. |
|
Let's discuss it in person tomorrow |
Added a new section in the getting started tutorial to highlight the import tool for quick data entry. Moved and updated the import tool guide to the web interface docs, adjusted navigation metadata, and improved formatting and clarity in the import tool documentation.
|
Hi Peter, I think this is ready to be merged. I added an import tool doc and a 2fa doc |
Added new images for the electrophysiology workflow and web interface tutorials. Updated 'electrophysiology-workflow.md' to include screenshots for project, subject, cohort creation, equipment list, and procedure view. Expanded 'import-tool.md' with an interface overview, new screenshot, and reorganized CSV field documentation for clarity. Improved 'two-factor-authentication.md' for conciseness, clarified setup steps, and updated security and troubleshooting sections.
Replaces 'physical_dimensions_json' with 'specifications' in setup documentation and examples. Refactors and clarifies tutorials for behavioral paradigms, electrophysiology workflow, data storage, group and project management, and lab infrastructure. Improves navigation order, removes outdated screenshots, and enhances consistency and clarity across documentation.
Standardized field names for data storage protocols and organization in API and tutorial docs. Revised setup specifications to use key-value format and clarified documentation. Expanded and improved the resource and taxonomy submission tutorial with detailed instructions, tables, and best practices. Updated links and examples for public data sharing and storage management.
Added new tutorials covering behavioral paradigms, electrophysiology workflow, managing data storage, setting up lab infrastructure, and two-photon imaging workflow. Updated existing tutorials to reference new guides, expanded instructions for personal attributes, group and project management, and API usage. These changes improve documentation coverage and provide step-by-step guidance for users on experimental setup, data management, and programmatic access.