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

Auto generated documentation #35

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Conversation

gabewillen
Copy link
Contributor

You don't have to merge this. Just an example of auto generated documentation using AI. Unlike pasting code into chat-gpt or using copilot. This tool builds full dependency graphs and sends all the relevant code to the model in the context. It then injects the documentation into the parsed AST leaving the existing code untouched.

@gabewillen
Copy link
Contributor Author

The entire process took two minutes

@gabewillen
Copy link
Contributor Author

Want me to delete this PR?

@Blaizzy
Copy link
Owner

Blaizzy commented Jun 1, 2024

No, please keep it.

It's pretty interesting and I have lots of questions! 🔥

At the moment, I'm out on a trip for the weekend and will get back to all your comments soon :)

If it's open-source we might merge it and have it as a default tool like gradio.

@Blaizzy
Copy link
Owner

Blaizzy commented Jun 3, 2024

You don't have to merge this. Just an example of auto generated documentation using AI. Unlike pasting code into chat-gpt or using copilot. This tool builds full dependency graphs and sends all the relevant code to the model in the context. It then injects the documentation into the parsed AST leaving the existing code untouched.

I'm back,

@gabewillen this is impressive!

Where can I learn more about it?

@gabewillen
Copy link
Contributor Author

Hey and thanks! I'm finishing it up now yours was only but a few I've ran it completely on. Soon it will actually create material ui mkdoc sites along with the documentation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants