Significant-Gravitas/AutoGPT

Move to a single source of truth for docs — Remove duplicate info from readme

Open

#8.887 aberto em 5 de dez. de 2024

Ver no GitHub
 (2 comments) (0 reactions) (0 assignees)Python (46.237 forks)batch import
good first issue

Métricas do repositório

Stars
 (184.310 stars)
Métricas de merge de PR
 (Mesclagem média 10d 15h) (100 fundiu PRs em 30d)

Description

autogpt_platform\backend\README.advanced.md and autogpt_platform\backend\README.md. We should just point people to the docs directory (docs/platform/advanced_setup|getting-started) in these. Check the content is all in that file, and the normal getting started, then remove these two files and replace with a link to the docs site — the dev-docs.agpt.co and docs.agpt.co. Call out both and their branch match for released master vs dev branch

Guia do colaborador

Direção de pesquisa
A issue requer a remoção de informações duplicadas de dois arquivos README: autogpt platform/backend/README.advanced.md e autogpt platform/backend/README.md. Primeiro, verifique se o conteúdo desses arquivos existe no diretório docs em docs/platform/advanced setup e docs/platform/getting started. Em seguida, substitua o conteúdo de ambos os arquivos README por links para dev docs.agpt.co (para o branch dev) e docs.agpt.co (para o branch master), garantindo que os links apontem para a documentação correta correspondente ao branch. Nenhuma alteração de código é necessária; apenas edição de markdown.
Pilha de tecnologia
None
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.
1
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Menos de 1 hora
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
GitMarkdown
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
90