LAION-AI / LAION-AI/Open-Assistant
Add API availability warning to the API documentation.
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 37.4k
- Forks
- 3.3k
- PR merge metrics
- No merged PRs in 30d
Description
Since there is a large number of people asking about a public API I feel as if a small warning at the top of the API docs to clarify that a public API isn't currently available is in order. It could additionally link to the FAQ question which goes into more detail.
It could read: "Open Assistant's API is for internal use only. However, the API code is available for hosting the model on your own hardware or with a cloud provider. See the FAQ for details."
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
Open the API documentation at the linked page and place the availability warning at the top, including the FAQ link provided in the issue. Done means visitors can see that the public API is unavailable and follow the FAQ link for more details.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100