Significant-Gravitas/AutoGPT

Auto-GPT developer documentation 📔

Aberta

#5.191 aberto em 10 de set. de 2023

Ver no GitHubGuia do colaborador
 (11 comentários) (7 reações) (0 responsável)Python (46.237 forks)batch import
AndroidClassic AutoGPT AgentGood first issueTTShelp wantedproject management

Métricas do repositório

Stars
 (184.310 estrelas)
Métricas de merge de PR
 (Métricas PR pendentes)

Description

Auto-GPT is an experimental project, where we want to encourage involvement and empower anyone to contribute. We also want to work based off of research and data rather than gut feelings. To enable all of this, we need better architectural and design documentation.

TODO

- [ ] Make Jupyter notebooks for all of our prompting No longer applicable

  • Document the application's program flow (including architectural notes) in Whimsical and/or Markdown
  • Add references to this new documentation in all the right places
    • Contributor guide
    • README
    • Docs site
  • Require PRs to include updates to developer docs if applicable
  • Add documentation delineating all components that can be used (see https://www.home-assistant.io/integrations/)
  • Add documentation on building agents using forge (and other autogpt components)
  • Add library documentation for Platfomr and AutoGPT components
  • Document supported versions of various components

Guia do colaborador

Direção de pesquisa
Comece explorando a estrutura atual da documentação no repositório, especialmente a pasta /docs e quaisquer arquivos markdown existentes. Revise o guia do contribuidor e o README para identificar onde a nova documentação deve ser vinculada. Examine a referência de integrações do Home Assistant para inspiração de estilo. Interaja com os mantenedores nos comentários da issue para esclarecer as prioridades e os critérios de aceitação para cada item TODO.
Pilha de tecnologia
python
Domain
documentation
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.
2
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
GitPython
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70