Significant-Gravitas/AutoGPT

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

Geschlossen

#8.887 geöffnet am 05.12.2024

Auf GitHub ansehenContributor Guide
 (2 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Python (46.237 Forks)batch import
CarPlayGood first issue

Repository-Metriken

Stars
 (184.310 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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

Contributor Guide

Research-Richtung
Das Issue erfordert das Entfernen doppelter Informationen aus zwei README Dateien: autogpt platform/backend/README.advanced.md und autogpt platform/backend/README.md. Überprüfe zunächst, ob der Inhalt dieser Dateien im docs Verzeichnis unter docs/platform/advanced setup und docs/platform/getting started vorhanden ist. Ersetze dann den Inhalt beider README Dateien durch Links zu dev docs.agpt.co (für den dev Branch) und docs.agpt.co (für den master Branch), wobei sichergestellt werden muss, dass die Links auf die korrekte, branch entsprechende Dokumentation verweisen. Es sind keine Codeänderungen erforderlich; nur Bearbeitung von Markdown.
Tech Stack
Keine
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitMarkdown
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
90