Significant-Gravitas/AutoGPT

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

Open

#8,887 opened on Dec 5, 2024

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Python (184,310 stars) (46,237 forks)batch import
good first issue

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

Contributor guide

Tech stack
None
Domain
documentationcontent
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
The issue requires removing duplicate information from two README files: autogpt platform/backend/README.advanced.md and autogpt platform/backend/README.md. First, verify that the content from these files exists in the docs directory at docs/platform/advanced setup and docs/platform/getting started. Then, replace the contents of both README files with links to dev docs.agpt.co (for dev branch) and docs.agpt.co (for master branch), ensuring the links point to the correct branch matched documentation. No code changes are needed; only markdown editing.