DesignSafe-CI / DesignSafe-CI/DS-User-Guide
Standardize Use Case Content Beyond Just Header
Open
@silviamazzoni is already working on this.
Since Aug 14, 2024.
2024-08
enhancement
- Dominant language
- Tcl
- Stars
- 1
- Forks
- 27
- PR merge metrics
- No merged PRs in 30d
Description
Overview
Use Case format has consistent header, but content still has inconsistent user experience e.g.
- images not nested within list item they belong to
- steps using bullets instead of numbers
out-of-date screenshots→ logged issues
Ideas
A. Add Requirements
And examples of how to achieve them:
- Captions for Images
- Numbered List for Steps
- Relate Images to Steps
B. Offer Multiple Ways to Relate Images to Steps
- nest image within relevant text step of long list
- show images in sequence after text steps of short list
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.