LAION-AI/Open-Assistant

Create docs showing how to interact with the api

Open

#1.460 geöffnet am 11. Feb. 2023

Auf GitHub ansehen
 (9 Kommentare) (0 Reaktionen) (1 zugewiesene Person)Python (37.363 Stars) (3.263 Forks)batch import
documentationgood first issue

Beschreibung

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
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 hours
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
active
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
Basic PythonUnderstanding REST APIs
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80
Research-Richtung
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.