Study Management update for the help guide#17
Open
nurikarakaya wants to merge 15 commits intomainfrom
Open
Conversation
crude structure created
Remove duplicate content from nav-studies.md, fix anchor links in Study Management page, and improve navigation structure. Creates single source of truth for study management documentation.
gcurrie768
reviewed
Jul 25, 2025
gcurrie768
left a comment
There was a problem hiding this comment.
These sections look great Nuri! I have made a few minor suggestions :)
| {: #delete-search} | ||
| > **⚠️ Warning:** This action cannot be undone. This will remove the systematic search from this project, and all screenings, annotations and outcome data for studies in this search will be lost. | ||
|
|
||
| Click the red delete button (trash icon) in the Actions column: |
There was a problem hiding this comment.
Should we call it an Actions column or not? Not sure what the answer is but maybe check with others in the team!
study-management.md
Outdated
|
|
||
| Then click **Study Management** to access the administrative interface: | ||
|
|
||
| {: style="border: 2px solid #ccc; padding:10px;"} |
Member
There was a problem hiding this comment.
If only keeping one screenshot - i would argue the second screenshot it better than the 1st
| - **Action buttons**: Upload new searches and bulk update studies | ||
| - **Bulk operations**: Select multiple searches for Risk of Bias calculations | ||
| - **Progress indicators**: Real-time status updates with clickable links to detailed progress | ||
| - **Overflow menu**: View studies, delete systematic searches, run Risk of Bias assessment for a single search, copy the ID of a search |
Member
There was a problem hiding this comment.
I would have thought that the information presented below in the numbered sections would follow this order - but it does not. I don't think it needs to follow the order of actions, operations, progress indicators, and overflow menu. Perhaps this section can be updated after the info below has been refined.
…page organization - Create new calculate-risk-of-bias.md sub-page for Risk of Bias functionality - Move Risk of Bias assessment content from main page to dedicated sub-page - Restructure study-management.md with clearer section organization - Update navigation links and fix anchor IDs for proper internal linking - Add important notes to prepare-references and manage-pdfs pages - Improve page layout and content flow based on reviewer feedback Addresses reviewer comments on content organization and navigation
…contents - Add automatic TOC generation to all Study Management pages - Remove redundant headers that duplicate page titles - Standardize formatting across study-management sub-pages - Improve page navigation and consistency Applied to: study-management, prepare-references, upload-search, manage-pdfs, manage-studies, and calculate-risk-of-bias pages
…nchor link for view studies
ed12055 to
e4b5c31
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What?
Update the Study Management section in the help guide.
Why?
To provide clearer, more accurate, and up-to-date instructions for users managing studies.
How?
Revised the content and related files to improve explanations, add missing details, and update screenshots.
Testing?
Reviewed the rendered site locally to ensure formatting, links, and images display correctly. Checked for typos and broken links.
Screenshots (optional)
Anything Else?
Please let me know if further changes are needed.