AutoGPT icon indicating copy to clipboard operation
AutoGPT copied to clipboard

add autodoc index and config

Open samheutmaker opened this issue 1 year ago • 2 comments

Background

This PR adds autodoc codebase documentation to the Auto-GPT project. This allows developers to ask questions about the Auto-GPT codebase and get GPT-4 powered answers.

Changes

This change add adds the autodoc.config.js file and the .autodoc folder to the root of the project. The configuration files holds configuration information for the index and folder holds pre-computed documentation and a very small vector index. These are used to enable the doc q query flow as described here.

Documentation

View autodoc documentation here.

Test Plan

This is only adds documentation.

PR Quality Checklist

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

samheutmaker avatar Apr 15 '23 19:04 samheutmaker

@richbeales Isn't it autogenerated? Should we commit it at all?

nponeccop avatar Apr 16 '23 13:04 nponeccop

Notice pending review: we are not merging into stable. Changing the base branch to master.

Pwuts avatar Apr 22 '23 10:04 Pwuts

This is a mass message from the AutoGPT core team. Our apologies for the ongoing delay in processing PRs. This is because we are re-architecting the AutoGPT core!

For more details (and for infor on joining our Discord), please refer to: https://github.com/Significant-Gravitas/Auto-GPT/wiki/Architecting

p-i- avatar May 05 '23 00:05 p-i-

Hi @samheutmaker, thanks for submitting this PR and sorry for not coming back on it earlier. I don't see a real need for this in our project at the moment, but it is very similar to something that we do very much need: a way to index/process/memorize programming code in a file or folder. See also #3536

Please let us know if you would be interested in contributing in that area. Some research has been done but so far we have no working memorization routines for programming code.

Pwuts avatar May 30 '23 16:05 Pwuts