Update docs quick overview #988
Conversation
| ### 1. AI Class (`gpt_engineer/ai.py`) | ||
| The AI class is the main interface to the GPT-4 model. It provides methods to start a conversation with the model, continue an existing conversation, and format system and user messages. | ||
|
|
||
| (ai_class)= |
There was a problem hiding this comment.
Is this some markdown extension I'm not aware of? Never seen before 😮
There was a problem hiding this comment.
Me neither! Apparently, its Sphinx way of doing cross-references in the MyST Markdown dialect (see docs).
|
Maybe outside the scope of what you want to do in this PR @kristiankyvik, but feel free to cut down A LOT on the static documentation files (the ones not generated from docstrings). Chances are that they are outdated and it doesn't seem like we are managing to keep non-generated doc files up-to-date. |
|
Hi @ATheorell, Could it make sense to merge this PR in the meantime so that at least the main overview is up-to-date? |
|
Looks good! Thank you @kristiankyvik . Yes would be great if you had time to look at the auto generated docs too Edit -looks like you already are looking at that. Nice one |
My attempt here was to update the Quick overview section of the docs, since it seems to be out of date.
Here are the summary of the changes:
I also documented a command to run the docs with live reload, which will make it easier to work with them locally.