Significant-Gravitas/AutoGPT

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

Open

#8 887 ouverte le 5 déc. 2024

Voir sur GitHub
 (2 commentaires) (0 réactions) (0 assignés)Python (46 237 forks)batch import
good first issue

Métriques du dépôt

Stars
 (184 310 stars)
Métriques de merge PR
 (Merge moyen 10j 15h) (100 PRs mergées en 30 j)

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

Guide contributeur

Direction de recherche
Ce problème nécessite de supprimer les informations en double de deux fichiers README : autogpt platform/backend/README.advanced.md et autogpt platform/backend/README.md. Tout d'abord, vérifiez que le contenu de ces fichiers existe dans le répertoire docs sous docs/platform/advanced setup et docs/platform/getting started. Ensuite, remplacez le contenu des deux fichiers README par des liens vers dev docs.agpt.co (pour la branche dev) et docs.agpt.co (pour la branche master), en veillant à ce que les liens pointent vers la documentation correcte correspondant à la branche. Aucune modification de code n'est nécessaire ; uniquement une édition de markdown.
Stack technique
Aucun
Domaine
documentation
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.
Moins d'une heure
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
GitMarkdown
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90