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 autodoc index and config #1687

Closed

Conversation

samheutmaker
Copy link

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

@nponeccop
Copy link
Contributor

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

@Pwuts Pwuts added the documentation Improvements or additions to documentation label Apr 22, 2023
@Pwuts
Copy link
Member

Pwuts commented Apr 22, 2023

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

@Pwuts Pwuts changed the base branch from stable to master April 22, 2023 10:35
@p-i-
Copy link
Contributor

p-i- commented May 5, 2023

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

@Pwuts Pwuts added the needs discussion To be discussed among maintainers label May 30, 2023
@Pwuts
Copy link
Member

Pwuts commented May 30, 2023

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 Pwuts closed this May 30, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation needs discussion To be discussed among maintainers
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

None yet

4 participants