LAION-AI/Open-Assistant

Create docs showing how to interact with the api

Open

#1,460 建立於 2023年2月11日

在 GitHub 查看
 (9 留言) (0 反應) (1 負責人)Python (37,363 star) (3,263 fork)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
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 hours
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
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.