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 (46,237 forks)batch import
good first issue

Repository metrics

Stars
 (184,310 stars)
PR merge metrics
 (Avg merge 10d 15h) (100 merged PRs in 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

Contributor guide

Research direction
Compare the content of the two README files with the docs site to ensure no information is lost, then replace the files with links to the appropriate docs sites.
Tech stack
None
Domain
documentation
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitMarkdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90