Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Clean up README #2040

Merged
merged 2 commits into from
Apr 17, 2023
Merged

Clean up README #2040

merged 2 commits into from
Apr 17, 2023

Conversation

Pwuts
Copy link
Member

@Pwuts Pwuts commented Apr 17, 2023 •
edited
Loading

Background

The README is quite cluttered atm and could use some readability improvements.

Changes

  • Big "Get help" header
  • Clear instructions to download stable
  • Remove Table of Contents. It is very long, has to be maintained manually, and is redundant since GitHub generates one automatically based on the headings in the README
  • Indentation & whitespace fixes
  • Added instructions for docker-compose

Documentation

Yes

PR Quality Checklist

  • My pull request is atomic and focuses on a single change.
  • I have thoroughly tested my changes with multiple different prompts.
  • I have considered potential risks and mitigations for my changes.
  • I have documented my changes clearly and comprehensively.
  • I have not snuck in any "extra" small tweaks changes

@nponeccop nponeccop added documentation Improvements or additions to documentation B7 labels Apr 17, 2023
@BillSchumacher BillSchumacher merged commit 42f81c6 into Significant-Gravitas:master Apr 17, 2023
@Pwuts Pwuts deleted the patch-1 branch April 17, 2023 01:36
This was referenced Apr 17, 2023
Closed
Closed
@nponeccop nponeccop mentioned this pull request Apr 17, 2023
Closed
1 task
@Androbin Androbin mentioned this pull request Apr 18, 2023
Merged
5 tasks
sindlinger pushed a commit to Orgsindlinger/Auto-GPT-WebUI that referenced this pull request Sep 25, 2024
@BillSchumacher
Merge pull request Significant-Gravitas#2040 from Pwuts/patch-1
eb7a46f 
Clean up README
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@BillSchumacher BillSchumacher BillSchumacher approved these changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@Pwuts @BillSchumacher @nponeccop