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.