Significant-Gravitas/AutoGPT

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

Open

#8887 aperta il 5 dic 2024

Vedi su GitHub
 (2 commenti) (0 reazioni) (0 assegnatari)Python (46.237 fork)batch import
good first issue

Metriche repository

Star
 (184.310 star)
Metriche merge PR
 (Merge medio 10g 15h) (100 PR mergiate in 30 g)

Descrizione

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

Guida contributor

Direzione di ricerca
Il problema richiede di rimuovere le informazioni duplicate da due file README: autogpt platform/backend/README.advanced.md e autogpt platform/backend/README.md. Innanzitutto, verifica che il contenuto di questi file esista nella directory docs in docs/platform/advanced setup e docs/platform/getting started. Quindi, sostituisci il contenuto di entrambi i file README con collegamenti a dev docs.agpt.co (per il ramo dev) e docs.agpt.co (per il ramo master), assicurandoti che i collegamenti puntino alla documentazione corretta corrispondente al ramo. Non sono necessarie modifiche al codice; solo modifiche al markdown.
Tech stack
Nessuno
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
GitMarkdown
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
90