LAION-AI/Open-Assistant

Create docs showing how to interact with the api

Aberta

#1.460 aberto em 11 de fev. de 2023

Ver no GitHubGuia do colaborador
 (9 comentários) (0 reação) (1 responsável)Python (3.263 forks)batch import
documentationgood first issue

Métricas do repositório

Stars
 (37.363 estrelas)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

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.

Guia do colaborador

Direção de pesquisa
Explore as rotas da API existentes no código e qualquer documentação já disponível. Crie um guia mostrando como enviar requisições para os endpoints da API, incluindo autenticação se necessário. Considere usar um notebook Jupyter para demonstrar exemplos interativamente.
Pilha de tecnologia
python
Domain
backendapi
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
1
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Gitbasic API knowledge
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
85