LAION-AI/Open-Assistant

Create docs showing how to interact with the api

Open

#1 460 ouverte le 11 févr. 2023

Voir sur GitHub
 (9 commentaires) (0 réactions) (1 assigné)Python (3 263 forks)batch import
documentationgood first issue

Métriques du dépôt

Stars
 (37 363 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

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.

Guide contributeur

Direction de recherche
Explorez les routes API existantes dans le code et toute documentation existante. Créez un guide montrant comment envoyer des requetes aux points de terminaison de l'API, y compris l'authentification si nécessaire. Envisagez d'utiliser un notebook Jupyter pour démontrer des exemples de manière interactive.
Stack technique
python
Domaine
backendapi
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Gitbasic API knowledge
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
85