LAION-AI/Open-Assistant

Create docs showing how to interact with the api

Open

#1,460 opened on 2023年2月11日

GitHub で見る
 (9 comments) (0 reactions) (1 assignee)Python (37,363 stars) (3,263 forks)batch import
documentationgood first issue

説明

Create some docs showing examples of how to interact and use the api.

Maybe also or instead could just be a notebook too.

Should be a good first issue for someone.

I'm happy to help anyone if needed.

コントリビューターガイド

技術スタック
pythonrest api
領域
documentationapi
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3 hours
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
active
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
clear
前提条件
Basic PythonUnderstanding REST APIs
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
80
調査方針
Review the existing API implementation in the repository to understand the endpoints and request/response formats. Then create a Markdown document or Jupyter notebook with example API calls (e.g., using curl or Python requests). Consider consulting the issue comments for any specific preferences from the maintainers. The deliverable should be a PR adding the documentation to a docs/ folder or as specified.