From 622ac63c667384e985b951415bd792fd5f32e39e Mon Sep 17 00:00:00 2001 From: Jammy2211 Date: Mon, 13 Jul 2026 18:22:02 +0100 Subject: [PATCH] docs: require a GitHub connector for the chat-based assistant prompt MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The browser-chat bootstrap prompt pointed at the repo URL and fell back to "paste llms.txt/AGENTS.md if you can't browse GitHub". Recent ChatGPT builds treat a bare GitHub URL as needing the GitHub connector and skip the generic web fetch entirely, so the no-connector path became unreliable and, worse, could answer from stale training-data memory while appearing to use the repo. Make the connector the required, stated-up-front path and add a "tell me whether you can actually read the repo — don't answer from memory" handshake so a connector that didn't load surfaces instead of producing silent stale answers. Applied to both the README chat prompt and llms.txt. Co-Authored-By: Claude Opus 4.8 --- README.md | 17 ++++++++++------- llms.txt | 10 +++++----- 2 files changed, 15 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 1f724f4..7c180f8 100644 --- a/README.md +++ b/README.md @@ -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? ``` @@ -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: diff --git a/llms.txt b/llms.txt index 9d0e6e7..a7fcd09 100644 --- a/llms.txt +++ b/llms.txt @@ -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)