From ed8a807b6a42dc632956737ae7c4b08d5cf658b8 Mon Sep 17 00:00:00 2001 From: Paul Gauthier Date: Thu, 6 Jun 2024 09:22:08 -0700 Subject: [PATCH] moved _include -> _includes; added footer --- README.md | 2 +- website/_include/nav_footer_custom.html | 0 .../head_custom.html} | 0 website/_includes/nav_footer_custom.html | 6 + website/docs/faq.md | 107 +++++++++--------- 5 files changed, 61 insertions(+), 54 deletions(-) delete mode 100644 website/_include/nav_footer_custom.html rename website/{_include/head-custom.html => _includes/head_custom.html} (100%) create mode 100644 website/_includes/nav_footer_custom.html diff --git a/README.md b/README.md index 5de1f4647..64966642f 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,7 @@ $ aider --opus **See the [installation instructions](https://aider.chat/docs/install.html) -and +and other [documentation](https://aider.chat/docs/usage.html) for more details.** diff --git a/website/_include/nav_footer_custom.html b/website/_include/nav_footer_custom.html deleted file mode 100644 index e69de29bb..000000000 diff --git a/website/_include/head-custom.html b/website/_includes/head_custom.html similarity index 100% rename from website/_include/head-custom.html rename to website/_includes/head_custom.html diff --git a/website/_includes/nav_footer_custom.html b/website/_includes/nav_footer_custom.html new file mode 100644 index 000000000..f318b6910 --- /dev/null +++ b/website/_includes/nav_footer_custom.html @@ -0,0 +1,6 @@ + diff --git a/website/docs/faq.md b/website/docs/faq.md index 4abdb803e..b52e98d74 100644 --- a/website/docs/faq.md +++ b/website/docs/faq.md @@ -8,59 +8,6 @@ nav_order: 60 - TOC {:toc} -## Can I run aider in Google Colab? - -User [imabutahersiddik](https://github.com/imabutahersiddik) -has provided this -[Colab notebook](https://colab.research.google.com/drive/1J9XynhrCqekPL5PR6olHP6eE--rnnjS9?usp=sharing). - -## How can I run aider locally from source code? - -To run the project locally, follow these steps: - -``` -# Clone the repository: -git clone git@github.com:paul-gauthier/aider.git - -# Navigate to the project directory: -cd aider - -# Install the dependencies listed in the `requirements.txt` file: -pip install -r requirements.txt - -# Run the local version of Aider: -python -m aider.main -``` - - - -## Aider isn't editing my files? - -Sometimes the LLM will reply with some code changes that don't get applied to your local files. -In these cases, aider might say something like "Failed to apply edit to *filename*". - -This usually happens because the LLM is not specifying the edits -to make in the format that aider expects. -GPT-3.5 is especially prone to disobeying the system prompt instructions in this manner, but it also happens with stronger models. - -Aider makes every effort to get the LLM -to conform, and works hard to deal with -replies that are "almost" correctly formatted. -If Aider detects an improperly formatted reply, it gives -the LLM feedback to try again. -Also, before each release new versions of aider are -[benchmarked](https://aider.chat/docs/benchmarks.html). -This helps prevent regressions in the code editing -performance of an LLM that could have been inadvertantly -introduced. - -But sometimes the LLM just won't cooperate. -In these cases, here are some things you might try: - - - Use `/drop` to remove files from the chat session which aren't needed for the task at hand. This will reduce distractions and may help GPT produce properly formatted edits. - - Use `/clear` to remove the conversation history, again to help GPT focus. - - Try the a different LLM. - ## How can I add ALL the files to the chat? People regularly ask about how to add **many or all of their repo's files** to the chat. @@ -89,6 +36,60 @@ If you still wish to add lots of files to the chat, you can: - Use a wildcard with the in-chat `/add` command: `/add src/*.py` - Give the `/add` command a directory name and it will recurisvely add every file under that dir: `/add src` +## How can I run aider locally from source code? + +To run the project locally, follow these steps: + +``` +# Clone the repository: +git clone git@github.com:paul-gauthier/aider.git + +# Navigate to the project directory: +cd aider + +# Install the dependencies listed in the `requirements.txt` file: +pip install -r requirements.txt + +# Run the local version of Aider: +python -m aider.main +``` + + + +## Can I run aider in Google Colab? + +User [imabutahersiddik](https://github.com/imabutahersiddik) +has provided this +[Colab notebook](https://colab.research.google.com/drive/1J9XynhrCqekPL5PR6olHP6eE--rnnjS9?usp=sharing). + + +## Aider isn't editing my files? + +Sometimes the LLM will reply with some code changes that don't get applied to your local files. +In these cases, aider might say something like "Failed to apply edit to *filename*". + +This usually happens because the LLM is not specifying the edits +to make in the format that aider expects. +GPT-3.5 is especially prone to disobeying the system prompt instructions in this manner, but it also happens with stronger models. + +Aider makes every effort to get the LLM +to conform, and works hard to deal with +replies that are "almost" correctly formatted. +If Aider detects an improperly formatted reply, it gives +the LLM feedback to try again. +Also, before each release new versions of aider are +[benchmarked](https://aider.chat/docs/benchmarks.html). +This helps prevent regressions in the code editing +performance of an LLM that could have been inadvertantly +introduced. + +But sometimes the LLM just won't cooperate. +In these cases, here are some things you might try: + + - Use `/drop` to remove files from the chat session which aren't needed for the task at hand. This will reduce distractions and may help GPT produce properly formatted edits. + - Use `/clear` to remove the conversation history, again to help GPT focus. + - Try the a different LLM. + ## Can I change the system prompts that aider uses?