AberystwythSystemsBiology / AberystwythSystemsBiology/limbus

Documentation needs attention

Open
#114 3 comments 0 reactions 1 assignee Claimed by @KeironO View on GitHub
documentation enhancement good first issue help wanted
Dominant language
Python
Stars
43
Forks
6
PR merge metrics
No merged PRs in 30d

Description

**Is your feature request related to a problem? Please describe.**

We need to start prioritising user documentation. Lots of new features and workflows have been added since 21.01.

**Describe the solution you'd like**

- **Deployment:** How to get the system set up. This can be limited to docker.
- **Getting Started:**
- How to get a user set up after set up.
- How to give feedback.
- Overview Panel
- Search.
- Find out which version is being run.
- **Sample Data Entry:**
- A graphical overview of Sample entry procedure.
- Setting up required forms (PROTOCOLS).
- Making a new Sample.
- Viewing a Sample
- **Donor Data Entry:**
- A graphical overview of Donor entry procedure.
- Making a new Donor
- Viewing a Donor
- Associating a Donor to Sample
- Setting up disease information

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.