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 (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.

Guide contributeur

Stack technique
pythonrest api
Domaine
documentationapi
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.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 hours
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.
clear
Prérequis
Basic PythonUnderstanding REST APIs
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80
Direction de recherche
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.