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.

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

Add links to github issues in the README and clarify run instructions #4954

Merged

Conversation

collijk
Copy link
Contributor

@collijk collijk commented Jul 12, 2023

Background

The existing readme lack references to other documentation resources and people have been having issues with the run instructions.

Changes

  • Add an overview with links to relevant github issues.
  • Add more clarity about installing autogpt and where to do it from (this was a user testing issue)
  • Add more clarity about where a users home directory is on different platforms (this was a user testing issue)
  • Add more clarity about what isn't being worked on (the cli web app) as this caused some user confusion.

Documentation

All Docs

Test Plan

X

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.
  • I have run the following commands against my code to ensure it passes our linters:
    black .
    isort .
    mypy
    autoflake --remove-all-unused-imports --recursive --ignore-init-module-imports --ignore-pass-after-docstring autogpt tests --in-place

@collijk collijk requested a review from ntindle July 12, 2023 15:34
@netlify
Copy link

netlify bot commented Jul 12, 2023

Deploy Preview for auto-gpt-docs canceled.

Name Link
🔨 Latest commit ff6cda2
🔍 Latest deploy log https://app.netlify.com/sites/auto-gpt-docs/deploys/64aecd38c4cab900073a7667

@collijk collijk added this to the v0.4.5 Release milestone Jul 12, 2023
@codecov
Copy link

codecov bot commented Jul 12, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (21c0cdc) 51.01% compared to head (ff6cda2) 51.01%.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #4954   +/-   ##
=======================================
  Coverage   51.01%   51.01%           
=======================================
  Files         119      119           
  Lines        4895     4895           
  Branches      643      643           
=======================================
  Hits         2497     2497           
  Misses       2217     2217           
  Partials      181      181           

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@collijk collijk merged commit 3582ada into Significant-Gravitas:master Jul 12, 2023
16 checks passed
@collijk collijk deleted the documentation/update-rearch-readme branch July 12, 2023 17:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

None yet

2 participants