OpenFreeEnergy / OpenFreeEnergy/feflow
Try to document where the protocols are useful in projects
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 20
- Forks
- 4
- PR merge metrics
- No merged PRs in 30d
Description
We have received feedback from leadership that it would be important to document where the different protocols and tools in FEFlow are being used, in terms of projects and the "big picture". We will have to think about how and where to do this, but it's important in terms of tracking the relevance of the different components.
A possibility would be just a docstring in the different modules, but we probably want to eventually have a user facing documentation that helps with this.
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 FEFlow modules containing the different protocols and tools, then identify how each is used in projects. Decide whether module docstrings or user-facing documentation is the appropriate location. Done means the relevant components and their project-level purpose are documented in an agreed location.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100