LAION-AI/Open-Assistant

Create docs showing how to interact with the api

Offen

#1.460 geöffnet am 11.02.2023

Auf GitHub ansehenContributor Guide
 (9 Kommentare) (0 Reaktionen) (1 zugewiesene Person)Python (3.263 Forks)batch import
documentationgood first issue

Repository-Metriken

Stars
 (37.363 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

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

Research-Richtung
Erkunde die vorhandenen API Routen im Code und die bestehende Dokumentation. Erstelle eine Anleitung, die zeigt, wie man Anfragen an die API Endpunkte sendet, einschließlich Authentifizierung falls erforderlich. Erwäge die Verwendung eines Jupyter Notebooks, um Beispiele interaktiv zu demonstrieren.
Tech Stack
python
Domain
backendapi
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Gitbasic API knowledge
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
85