OpenFreeEnergy / OpenFreeEnergy/feflow
Add API docs and a userguide
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 20
- Forks
- 4
- PR merge metrics
- No merged PRs in 30d
Description
Even if it's just a placeholder for now, we should add some docs so that folks know how to go about installing FEFlow, what Protocols are in it, and how to use them.
Contributor guide
No contributing guide indexed for this repository
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 reviewing the existing FEFlow project structure and any current installation or usage guidance. Create documentation covering installation, what Protocols are, and how to use them; it is done when users can find an API documentation or user guide that addresses those three topics.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100