Skip to content

docs: clarify aider-install env and link local-model setup#5127

Open
ChrisJr404 wants to merge 1 commit into
Aider-AI:mainfrom
ChrisJr404:docs-install-clarify-env-and-local-models
Open

docs: clarify aider-install env and link local-model setup#5127
ChrisJr404 wants to merge 1 commit into
Aider-AI:mainfrom
ChrisJr404:docs-install-clarify-env-and-local-models

Conversation

@ChrisJr404
Copy link
Copy Markdown

The install page's "Get started quickly" section ends with:

This will install aider in its own separate python environment.

After the included get-started.md block, the sentence sits right under the aider --model deepseek ... example, so "This" reads as if it refers to the model command rather than aider-install. Issue #5115 calls this out, along with the install guide showing only cloud-provider examples.

Two small edits:

  • _includes/get-started.md: add a short pointer below the model examples to the Ollama, LM Studio, and OpenAI-compatible setup pages so users running a local LLM can find the right page from the install guide.
  • docs/install.md: rewrite the "This will install..." sentence to name aider-install explicitly, and clarify why a separate env is used.

Closes #5115

The install page's 'Get started quickly' section ended with 'This
will install aider in its own separate python environment.' which
was ambiguous about whether 'This' referred to the model command
just shown or to aider-install. Make the subject explicit.

Also add a short pointer below the model examples so users running
Ollama, LM Studio, or a llama.cpp/OpenAI-compatible endpoint can
find the matching setup page from the install guide.

Closes Aider-AI#5115

Signed-off-by: ChrisJr404 <chris@hacknow.com>
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.

[doc] install guide confusing

1 participant