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

Documentation/collate rearch notes #4958

Merged

Conversation

collijk
Copy link
Contributor

@collijk collijk commented Jul 12, 2023

Background

Lots of docs for the re-arch live in ephemeral issues and discord. Collating them here.

Changes

  • Add an ARCHITECTURE_NOTES.md to the core subpackage with notes from github and discord.

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

@netlify
Copy link

netlify bot commented Jul 12, 2023

Deploy Preview for auto-gpt-docs canceled.

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

@codecov
Copy link

codecov bot commented Jul 12, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (3582ada) 51.01% compared to head (4873bbf) 51.01%.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #4958   +/-   ##
=======================================
  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 077e143 into Significant-Gravitas:master Jul 13, 2023
@lc0rp lc0rp added this to the v0.4.5 Release milestone Jul 14, 2023
dayofthedave pushed a commit to dayofthedave/Auto-GPT that referenced this pull request Jul 17, 2023
* Add links to github issues in the README and clarify run instructions

* Added a new doc in the core package with architecture notes.
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.

3 participants