Added tips

This commit is contained in:
Paul Gauthier 2024-07-05 14:05:26 -03:00
parent 9ab36b565d
commit cd81e967f3
11 changed files with 52 additions and 9 deletions

View file

@ -96,6 +96,10 @@ class YamlHelpFormatter(argparse.HelpFormatter):
# Place in your home dir, or at the root of your git repo.
##########################################################
# Note: You can only put OpenAI and Anthropic API keys in the yaml
# config file. Keys for all APIs can be stored in a .env file
# https://aider.chat/docs/config/dotenv.html
"""
def _format_action(self, action):

View file

@ -37,3 +37,8 @@ nav_external_links:
url: "https://discord.gg/Tv2uQnR88V"
repository: paul-gauthier/aider
callouts:
tip:
title: Tip
color: green

View file

@ -0,0 +1,6 @@
{: .tip }
All API keys can be stored in a
Use a [.env file](/docs/config/dotenv.html) to store API keys.
OpenAI and Anthropic keys can be stored in the
[YAML config file](/docs/config/aider_conf.html).

View file

@ -0,0 +1,4 @@
{: .tip }
Use `/help <question>` to ask aider about itself.
You can ask how to customize options or troubleshoot
errors and warnings.

View file

@ -5,8 +5,6 @@
Model foobar: Unknown context window size and costs, using sane defaults.
```
*You can probably ignore the unknown context window size and token costs warning.*
If you specify a model that aider has never heard of, you will get
this warning.
This means aider doesn't know the context window size and token costs
@ -18,6 +16,9 @@ See the docs on
[configuring advanced model settings](/docs/config/adv-model-settings.html)
for details on how to remove this warning.
{: .tip }
You can probably ignore the unknown context window size and token costs warning.
## Did you mean?
If aider isn't familiar with the model you've specified,

View file

@ -4,6 +4,10 @@
# Place in your home dir, or at the root of your git repo.
##########################################################
# Note: You can only put OpenAI and Anthropic API keys in the yaml
# config file. Keys for all APIs can be stored in a .env file
# https://aider.chat/docs/config/dotenv.html
##########
# options:

View file

@ -39,3 +39,6 @@ Using an `.env` file:
```
AIDER_DARK_MODE=true
```
{% include env-keys-tip.md %}

View file

@ -16,6 +16,8 @@ Below is a sample of the file, which you
can also
[download from GitHub](https://github.com/paul-gauthier/aider/blob/main/aider/website/assets/sample.aider.conf.yml).
{% include env-keys-tip.md %}
<!--[[[cog
from aider.args import get_sample_yaml
from pathlib import Path
@ -32,6 +34,10 @@ cog.outl("```")
# Place in your home dir, or at the root of your git repo.
##########################################################
# Note: You can only put OpenAI and Anthropic API keys in the yaml
# config file. Keys for all APIs can be stored in a .env file
# https://aider.chat/docs/config/dotenv.html
##########
# options:

View file

@ -9,6 +9,8 @@ description: Frequently asked questions about aider.
- TOC
{:toc}
{% include help-tip.md %}
## 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.

View file

@ -9,3 +9,5 @@ description: How to troubleshoot problems with aider and get help.
Below are some approaches for troubleshooting problems with aider.
{% include help.md %}
{% include help-tip.md %}

View file

@ -35,10 +35,18 @@ Use /help to see in-chat commands, run with --help to see cmd line args
...
```
{% include help-tip.md %}
## Adding files
Add the files that the aider will need to *edit*.
To edit files, you need to "add them to the chat".
Do this
by naming them on the aider command line.
Or, you can use the in-chat
`/add` command to add files.
Only add the files that need to be edited for your task.
Don't add a bunch of extra files.
If you add too many files, the LLM can get overwhelmed
and confused (and it costs more tokens).
@ -46,15 +54,13 @@ Aider will automatically
pull in content from related files so that it can
[understand the rest of your code base](https://aider.chat/docs/repomap.html).
You add files to the chat by naming them on the aider command line.
Or, you can use the in-chat
`/add` command to add files.
You can use aider without adding any files,
and it will try to figure out which files need to be edited based
on your requests.
But you'll get the best results if you add the files that need
to edited.
{: .tip }
You'll get the best results if you think about which files need to be
edited and add them to the chat.
## LLMs