LAION-AI/Open-Assistant

Create docs showing how to interact with the api

Open

#1460 opened on Feb 11, 2023

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

Description

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.

Contributor guide

Tech stack
pythonrest api
Domain
documentationapi
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic PythonUnderstanding REST APIs
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
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.