OpenFreeEnergy / OpenFreeEnergy/openfe
Improving userguide introduction
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 331
- Forks
- 56
- Avg merge
- 3d 9h
- Merged PRs (30d)
- 13
Description
cc @hannahbaumann
The userguide introduction is very specific to the idea of running a "workflow", and doesn't necessarily provide a lot of information about what else is in the userguide. From an initial look, it might be hard to know what to expect from the userguide from that page.
The general idea of "here are the main steps of my workflow and this is what the userguide breaks into" makes sense, but it might need some padding / restructuring?
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.
Research direction
Start by reading the userguide introduction and the surrounding userguide structure. Done means the introduction explains what the userguide covers while retaining and appropriately framing the workflow overview.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100