Repository navigation
docs: make PyAutoLens and PyAutoGalaxy assistant-first #645
Description
Overview
Make PyAutoLens and PyAutoGalaxy documentation assistant-first without separating conversational and coding tools into competing learning routes. Each Getting Started section will link to one AI Assistant, briefly mention conversation agents such as ChatGPT and coding agents such as Claude Code and Codex, and leave full setup details to the assistant repository.
Plan
- Add one concise AI Assistant entry at the start of each Getting Started section.
- Describe the remaining resources as “human-readable documentation and examples.”
- Remove the “Three Ways to Learn PyAutoLens” and chat-versus-agentic split.
- Preserve all existing Colab, workspace, installation, and tutorial links.
- Build both Read the Docs sites and validate the assistant links.
- Hand off to the separately tracked workspace README phase.
Detailed implementation plan
Affected Repositories
- PyAutoLens (primary)
- PyAutoGalaxy
Work Classification
Library documentation; workspace README changes follow in phase 2.
Worktree Root
~/Code/PyAutoLabs-wt/assistant-first-docs/
Branch Survey
| Repository | Current branch | Dirty? | Claimed? |
|---|---|---|---|
| PyAutoLens | main |
clean | no |
| PyAutoGalaxy | main |
clean | no |
Both repositories are aligned with origin/main.
Suggested branch: feature/assistant-first-docs
Implementation Steps
- Update the PyAutoLens README and RTD landing page so the AI Assistant appears first under Getting Started.
- Remove the separate introductory AI callout and “Three Ways to Learn PyAutoLens” section.
- Replace the same split in the PyAutoLens new-user guide with one concise AI Assistant section.
- Add the equivalent assistant-first structure to the PyAutoGalaxy README, RTD landing page, and new-user guide.
- Introduce the remaining links as “human-readable documentation and examples.”
- Confirm the PyAutoGalaxy assistant URL resolves before publishing it.
- Search the scoped files for retired terminology and build both Sphinx documentation sites.
Key Files
PyAutoLens/README.mdPyAutoLens/docs/index.mdPyAutoLens/docs/overview/overview_2_new_user_guide.mdPyAutoGalaxy/README.mdPyAutoGalaxy/docs/index.mdPyAutoGalaxy/docs/overview/overview_2_new_user_guide.md
Original Prompt
Click to expand starting prompt
-
All readthedocs / README.md explaining the assistant should not have two separate splits for AI chat assistant
and Fully agentic AI, but instead just say AI assistant. They should concisely say conversation agents (e.g. ChatGPT)
and coding agents (e.g Claude, codex) and then point to the assistant URL, which is where the user gets the full scope. -
PyAutoLens and PyAutoGalaxy README.md should point to their assistant in the "Getting Started" section, and
then have the bit The following links are useful for new starters but say they are human readable docs. -
It feels like we are oging to get rid fo this section "## Three Ways to Learn PyAutoLens", and these style changes
will also hapepen on readthedocs and the workspace README.md files. -
the worksapce readme should keep the colab stuff, but point to the assistant in Getting Started first. Again
I think "## Three Ways to Learn PyAutoLens" will thus go.
Activity
Jammy2211 commentedon Jul 24, 2026
Library PR Created
API changes: None — documentation-only changes; the public Python APIs are unchanged.
Both Sphinx documentation builds passed. The future
autogalaxy_assistantURL currently returns 404, which the maintainer explicitly accepted pending creation of that assistant later today.Next: continue with the approved workspace README phase via
start-workspace.Jammy2211 commentedon Jul 24, 2026
Workspace PRs Created
The assistant-first documentation update is now implemented across both libraries and both workspaces.
Library PRs
Workspace PRs
All four PRs target
pending-release. This is documentation-only work with no API changes. The future PyAutoGalaxy assistant URL currently returns 404, which the user explicitly accepted because that repository will be created separately.Merge order: library PRs first, then the matching workspace PRs. Both library PRs are currently OPEN, so the workspace merges are intentionally blocked behind the library-first gate.
Jammy2211 commentedon Jul 24, 2026
Shipped — 2026-07-24
PRs
Summary
Unified the PyAutoLens and PyAutoGalaxy README, Read the Docs, and workspace Getting Started guidance around a single AI Assistant route. The assistant now leads the onboarding path for conversation and coding agents, while the remaining links are identified as human-readable documentation and examples. The obsolete Three Ways structure was removed and existing Colab material was preserved.
Validation
Session Notes
The future PyAutoGalaxy assistant URL currently returns 404; this was explicitly accepted because that repository will be created separately. Library PRs were merged before their matching workspace PRs.