-
Notifications
You must be signed in to change notification settings - Fork 0
[Feature]: Add screenshots to README #8
Copy link
Copy link
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or requestgood first issueGood for newcomersGood for newcomershelp wantedExtra attention is neededExtra attention is neededui-uxUser interface, user experience, wording, or layoutUser interface, user experience, wording, or layout
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or requestgood first issueGood for newcomersGood for newcomershelp wantedExtra attention is neededExtra attention is neededui-uxUser interface, user experience, wording, or layoutUser interface, user experience, wording, or layout
Feature summary
Add screenshots or placeholder screenshot sections to the README to help users and contributors understand the planned LabTools interface and workflow.
Related module
Documentation
Problem or workflow need
New visitors often decide whether to explore an open-source project based on the README. Screenshots help users quickly understand the purpose, interface direction, and workflow of BioMedPilot-LabTools.
Proposed solution
Add a screenshots section to README.md and README_zh.md.
Initial screenshots can include placeholder images or design mockups if the open-source UI is not available yet.
Suggested screenshot sections:
Formula or calculation logic
Not applicable.
Expected inputs and outputs
Inputs:
Outputs:
Example use case
A new contributor visits the repository and can immediately understand what the LabTools module is intended to look like, what workflows it supports, and where they might contribute.
References or notes
If real UI screenshots are not available yet, use simple placeholder images or clearly labeled mockups. Do not include private data, patient data, local file paths, or screenshots from private commercial modules.
Scope check