Skip to content

docs: require a GitHub connector for the chat-based assistant prompt #64

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Jammy2211 merged 1 commit into from
Jul 13, 2026
Merged

docs: require a GitHub connector for the chat-based assistant prompt #64

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 10 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,16 @@ depending on how hands-on you want the AI to be:
### AI Chat Assistant

Ask questions to a conversational AI assistant such as **ChatGPT** or **Claude**
in the browser. Paste this straight into ChatGPT or Claude to get started:
in the browser. First make sure your assistant has a **GitHub connector** enabled
so it can read this repository — without one it can't, and you should use a local
coding agent (below) instead. Then paste this to get started:

```
Read and use the autolens_assistant repository at
https://github.com/PyAutoLabs/autolens_assistant to answer PyAutoLens questions.
If you cannot browse GitHub, ask me to paste the repository's llms.txt and
AGENTS.md files instead.
Use the autolens_assistant repository to answer my PyAutoLens questions:
https://github.com/PyAutoLabs/autolens_assistant

First tell me whether you can actually read the repo. If you can't, say so
plainly — don't answer from memory.

How do I model a galaxy-scale strong lens observed with Hubble imaging?
```
Expand Down Expand Up @@ -171,8 +174,8 @@ the example starting prompts above.

If you are more familiar with conversation-based AI assistants such as ChatGPT or Claude on the
web, you can still use `autolens_assistant`. The front-door [`llms.txt`](llms.txt) holds the
bootstrap prompt and read-order: give the assistant this repository's URL together with that
prompt, or — if the chat cannot browse GitHub — paste `llms.txt` and `AGENTS.md` directly.
bootstrap prompt and read-order: with a GitHub connector enabled, give the assistant this
repository's URL and it reads the files itself.

This is effective for learning PyAutoLens, asking how to perform lensing calculations or modelling
tasks, interpreting and debugging errors, and getting draft code. However, it is not fully agentic:
Expand Down
10 changes: 5 additions & 5 deletions llms.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,17 @@

## Using it in chat (start here)

Point a coding agent or browser chat (ChatGPT, Claude) at this repo and open with:
First make sure your browser chat (ChatGPT, Claude) has a **GitHub connector** enabled so it can read this repository — without one it can't, so use a local coding agent instead. Then open with:

```text
I'd like to use the PyAutoLens Assistant for this conversation:
Use the autolens_assistant repository to answer my PyAutoLens questions:
https://github.com/PyAutoLabs/autolens_assistant

Please familiarize yourself with the project and use its guidance and scientific
reference material when answering my questions. I'll provide any local files or results you need.
First tell me whether you can actually read the repo. If you can't, say so
plainly — don't answer from memory.
```

Read order: [AGENTS.md](./AGENTS.md) → [skills/README.md](./skills/README.md) → the relevant skill → [wiki/](./wiki). If the chat can't browse GitHub, paste this file and `AGENTS.md`. The assistant can route to examples, explain lensing, review pasted scripts/errors/figures, and draft code; it cannot run code, inspect your files, or guarantee drafts against your installed PyAutoLens version. For repeated edits, live execution, or multi-session project state, switch to a local coding agent (or Codex web with the repo connected).
Read order: [AGENTS.md](./AGENTS.md) → [skills/README.md](./skills/README.md) → the relevant skill → [wiki/](./wiki). The assistant can route to examples, explain lensing, review pasted scripts/errors/figures, and draft code; it cannot run code, inspect your files, or guarantee drafts against your installed PyAutoLens version. For repeated edits, live execution, or multi-session project state, switch to a local coding agent (or Codex web with the repo connected).

## Agent instructions (canonical)

Expand Down
Loading