OpenProteinAI / OpenProteinAI/openprotein-docs
Update REST API docs for rfdiffusion and boltzgen
Open
Nobody has claimed this yet.
- Dominant language
- Jupyter Notebook
- Stars
- 0
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
Issue:
- REST API don’t show any parameters rfdiffusion and boltzgen
- Update endpoints to look more structured and provide documentation about the individual parameters
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 locating the REST API documentation for the rfdiffusion and boltzgen endpoints. Check which parameters are currently missing and how neighboring endpoints are structured. Done means both endpoints show their parameters, use a consistent structure, and document each individual parameter.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100