Skip to content

Study Management update for the help guide#17

Open
nurikarakaya wants to merge 15 commits intomainfrom
study-management-update
Open

Study Management update for the help guide#17
nurikarakaya wants to merge 15 commits intomainfrom
study-management-update

Conversation

@nurikarakaya
Copy link

@nurikarakaya nurikarakaya commented Jul 17, 2025

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.

@nurikarakaya nurikarakaya requested a review from chrissena July 17, 2025 15:32
@nurikarakaya nurikarakaya self-assigned this Jul 17, 2025
@nurikarakaya nurikarakaya changed the title docs: initial commit Study Management update for the help guide Jul 24, 2025
Copy link

@gcurrie768 gcurrie768 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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:

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we call it an Actions column or not? Not sure what the answer is but maybe check with others in the team!


Then click **Study Management** to access the administrative interface:

![Study Management Interface](figs/Fig_study-management-access-2.png){: style="border: 2px solid #ccc; padding:10px;"}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
@abannachbrown abannachbrown self-requested a review July 30, 2025 08:54
@nurikarakaya nurikarakaya force-pushed the study-management-update branch from ed12055 to e4b5c31 Compare July 30, 2025 10:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants