paul-gauthier / aider

aider is AI pair programming in your terminal
https://aider.chat/
Apache License 2.0
17.98k stars 1.68k forks source link

How can I point to specific framework's docs or examples? #1146

Closed djl0 closed 1 week ago

djl0 commented 3 weeks ago

Issue

If I want to build something using a relatively new framework which may have changes in syntax or design patterns since the model was trained (eg LlamaIndex or Polars), is there a way to point to that repo locally where docs or the code live?

Version and model info

No response

tdobson commented 3 weeks ago

There's not a sort of regular way of doing that easily within standard operations. I have sympathy for this, as I personally use a framework called Mantine and it's fairly new and rapidly changing (and I love it), but it means the models are frequently wrong unless I supply the docs.

There's no super standard way (at present) of saying "yo aider, the docs are here" other than perhaps scraping them all into a file and including them in the repo(?) or one off searching for the docs needed and adding them with /web or copy/pasting the relevant docs into the request you send aider.

I have a sense that as caching requests in some models becomes cheaper and more prevelant, we'll provide the docs to the models alongside the code, eg /add frameworkManual.md

tdobson commented 3 weeks ago

related: https://github.com/paul-gauthier/aider/issues/1005

paul-gauthier commented 2 weeks ago

Thanks for trying aider and filing this issue.

You can use /read to load in documentation.

djl0 commented 2 weeks ago

hi @paul-gauthier thanks for your reply! Is this a new feature? I don't see the command here: https://aider.chat/docs/usage/commands.html

Do you have any examples for this?

tdobson commented 2 weeks ago

/read is an alias for /read-only

/read big-documentation-manual.html /add frameworkfile.tsx Please change this framework file following the documentation!

On Fri, 30 Aug 2024 at 00:23, djl0 @.***> wrote:

hi @paul-gauthier https://github.com/paul-gauthier thanks for your reply! Is this a new feature? I don't see the command here: https://aider.chat/docs/usage/commands.html

Do you have any examples for this?

— Reply to this email directly, view it on GitHub https://github.com/paul-gauthier/aider/issues/1146#issuecomment-2319403993, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAJBQQG2I2UJ7NJJNDNRLODZT6UONAVCNFSM6AAAAABM5F66T6VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDGMJZGQYDGOJZGM . You are receiving this because you commented.Message ID: @.***>

paul-gauthier commented 1 week ago

I'm going to close this issue for now, but feel free to add a comment here and I will re-open or file a new issue any time.