Merge pull request #1028 from kristiankyvik/updating-static-docs

Thanks for the fixes! I'm now left with 2 warnings /home/axel/Software/gpt-engineer-dev/docs/index.rst:20: WARNING: toctree contains reference to nonexisting document 'docs_building' looking for now-outdated files... none found pickling environment... done checking consistency... /home/axel/Software/gpt-engineer-dev/docs/DOCS_BUILDING.md: WARNING: document isn't included in any toctree ..and I also have a fix for it! There is a reference to docs_building.md, whereas the files is called DOCS_BUILDING.md in all caps. I guess that you are running windows? Unix is case sensitive. Renaming the file removes the warning. I will merge your PR and fix this myself. Thanks a lot for saving the docs. Now they are both useful and easy to maintain.
AntonOsika · Mar 2, 2024 · dc54a8f · dc54a8f
2 parents 69fe820 + d845a5c
commit dc54a8f
Show file tree

Hide file tree

Showing 23 changed files with 117 additions and 539 deletions.
diff --git a/README.md b/README.md
@@ -53,7 +53,7 @@ Check the [Windows README](./WINDOWS_README.md) for windows usage.
 - Locate a folder with code which you want to improve anywhere on your computer
 - Create a file called `prompt` (no extension) inside your new folder and fill it with instructions for how you want to improve the code
 - Run `gpte <project_dir> -i` with a relative path to your folder
-  - For example: `gpte projects/my-old-project` from the gpt-engineer directory root with your folder in `projects/`
+  - For example: `gpte projects/my-old-project -i` from the gpt-engineer directory root with your folder in `projects/`
 
 By running gpt-engineer you agree to our [terms](https://github.com/gpt-engineer-org/gpt-engineer/blob/main/TERMS_OF_USE.md).
 

diff --git a/WINDOWS_README.md b/WINDOWS_README.md
@@ -27,7 +27,7 @@ Or:
 
 For **development**:
 
-- `git clone git@github.com:AntonOsika/gpt-engineer.git`
+- `git clone git@github.com:gpt-engineer-org/gpt-engineer.git`
 - `cd gpt-engineer`
 - `poetry install`
 - `poetry shell` to activate the virtual environment

diff --git a/docs/DOCS_BUILDING.md b/docs/DOCS_BUILDING.md
@@ -16,28 +16,29 @@ Read the Docs Build configuration is stored in `.readthedocs.yaml`.
 Example Project usage
 ---------------------
 
-`Poetry` is the package manager for `gpt-engineer`. In order to build documentation, we have to add docs requirements in
+``Poetry`` is the package manager for ``gpt-engineer``. In order to build documentation, we have to add docs requirements in
 development environment.
 
 This project has a standard readthedocs layout which is built by Read the Docs almost the same way that you would build it
 locally (on your own laptop!).
 
-You can build and view this documentation project locally - we recommend that you activate a `poetry shell`.
+You can build and view this documentation project locally - we recommend that you activate a ``poetry shell``.
 
-Update `repository_stats.md` file under `docs/intro`
+Update ``repository_stats.md`` file under ``docs/intro``
 
 ```console
 # Install required Python dependencies (MkDocs etc.)
 poetry install
 cd docs/
+
 # Create the `api_reference.rst`
 python create_api_rst.py
 
 # Build the docs
 make html
 
 ## Alternatively, to rebuild the docs on changes with live-reload in the browser
-sphinx-autobuild docs _build/html
+sphinx-autobuild . _build/html
 ```
 
 Project Docs Structure

diff --git a/docs/api_reference.rst b/docs/api_reference.rst
@@ -33,6 +33,7 @@ Functions
     applications.cli.collect.collect_learnings
     applications.cli.collect.send_learning
     applications.cli.learning.ask_collection_consent
+    applications.cli.learning.ask_for_valid_input
     applications.cli.learning.check_collection_consent
     applications.cli.learning.extract_learning
     applications.cli.learning.get_session
@@ -103,10 +104,11 @@ Functions
     :toctree: core
 
     core.ai.serialize_messages
-    core.chat_to_files.apply_edits
+    core.chat_to_files.apply_diffs
     core.chat_to_files.chat_to_files_dict
-    core.chat_to_files.overwrite_code_with_edits
-    core.chat_to_files.parse_edits
+    core.chat_to_files.parse_diff_block
+    core.chat_to_files.parse_diffs
+    core.chat_to_files.parse_hunk_header
     core.default.paths.memory_path
     core.default.paths.metadata_path
     core.default.simple_agent.default_config_agent
@@ -115,9 +117,12 @@ Functions
     core.default.steps.gen_code
     core.default.steps.gen_entrypoint
     core.default.steps.improve
-    core.default.steps.incorrect_edit
+    core.default.steps.salvage_correct_hunks
     core.default.steps.setup_sys_prompt
     core.default.steps.setup_sys_prompt_existing_code
+    core.diff.count_ratio
+    core.diff.is_similar
+    core.files_dict.file_to_lines_dict
 
 :mod:`gpt_engineer.tools`: Tools
 =================================

diff --git a/docs/index.rst b/docs/index.rst
@@ -1,59 +1,31 @@
 Welcome to GPT-ENGINEER's Documentation
-========================================
+=======================================
 
 .. toctree::
    :maxdepth: 2
-   :caption: INTRODUCTION:
+   :caption: GET STARTED:
 
-   intro/quick_overview.md
-   intro/repository_stats.md
-   intro/main_script.md
-   intro/scripts.md
-   intro/preprompts.md
+   introduction.md
+   installation
+   quickstart
 
 .. toctree::
    :maxdepth: 2
    :caption: USER GUIDES:
 
-   installation
-   usage
-   readme_link
    windows_readme_link
    open_models.md
    tracing_debugging.md
 
-
-.. toctree::
-   :maxdepth: 2
-   :caption: CORE COMPONENTS:
-
-   intro/gate.md
-   intro/ai_class.md
-   intro/db_class.md
-   intro/steps_module.md
-
-
-.. toctree::
-   :maxdepth: 2
-   :caption: HARMONY OF AI, DB, & STEPS:
-
-   intro/harmony_db_ai_steps.md
-
-.. toctree::
-   :maxdepth: 2
-   :caption: CHAT PARSING & SELF EXECUTION:
-
-   intro/chat_parsing.md
-
 .. toctree::
    :maxdepth: 2
-   :caption: CONTRIBUTING GUIDES:
+   :caption: CONTRIBUTE:
 
    contributing_link
-   DOCS_BUILDING.md
    roadmap_link
    code_conduct_link
    disclaimer_link
+   docs_building.md
    terms_link
 
 .. toctree::

diff --git a/docs/installation.rst b/docs/installation.rst
@@ -8,13 +8,13 @@ Installation
 Stable release
 --------------
 
-To install gpt-engineer, run this command in your terminal:
+To install ``gpt-engineer``, run this command in your terminal:
 
 .. code-block:: console
 
-    $ pip install gpt_engineer
+    $ python -m pip install gpt-engineer
 
-This is the preferred method to install file-processor, as it will always install the most recent stable release.
+This is the preferred method to install ``gpt-engineer``, as it will always install the most recent stable release.
 
 If you don't have `pip`_ installed, this `Python installation guide`_ can guide
 you through the process.
@@ -26,7 +26,7 @@ you through the process.
 From sources
 ------------
 
-The sources for file-processor can be downloaded from the `Github repo`_.
+The sources for ``gpt-engineer`` can be downloaded from the `Github repo`_.
 
 You can either clone the public repository:
 
@@ -48,7 +48,7 @@ Once you have a copy of the source, you can install it with:
 Troubleshooting
 ---------------
 
-For mac and linux system, there are sometimes slim python installations that do not include the gpt-engineer requirement tkinter, which is a standard library and thus not pip installable.
+For mac and linux system, there are sometimes slim python installations that do not include the ``gpt-engineer`` requirement tkinter, which is a standard library and thus not pip installable.
 
 To install tkinter on mac, you can for example use brew:
 

diff --git a/docs/intro/ai_class.md b/docs/intro/ai_class.md
diff --git a/docs/intro/chat_parsing.md b/docs/intro/chat_parsing.md
diff --git a/docs/intro/db_class.md b/docs/intro/db_class.md
diff --git a/docs/intro/gate.md b/docs/intro/gate.md
diff --git a/docs/intro/harmony_db_ai_steps.md b/docs/intro/harmony_db_ai_steps.md