OpenFreeEnergy / OpenFreeEnergy/openfe
add docs for troubleshooting simulation failures
Open
Nobody has claimed this yet.
documentation
- Dominant language
- Python
- Stars
- 332
- Forks
- 56
- Avg merge
- 3d 9h
- Merged PRs (30d)
- 13
Description
Is your feature request related to a problem? Please describe.
Users are requesting guide on common types of failures and their solutions.
Describe the solution you'd like
Describe alternatives you've considered
Additional context
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
The issue names no files, tests, or entry points. First identify the existing documentation structure and the simulation failure types and solutions that should be covered; done means a reviewed troubleshooting guide with practical guidance for common failures.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100