Repository navigation
Docs: lead Start Here with natural language or Python - #814
Merged
Merged
Conversation
Start Here opens with lensing, then a 'Natural Language or Python' section: the start-here prompt for the autolens_assistant, access/free options, why natural language (syntax is not the science) and that the Python API is not going anywhere and all docs stay human readable (HowToLens teaches the science). index.md and README Getting Started are restructured to match, the New User Guide's assistant boilerplate becomes one paragraph, and the copyable nl-prompt box is ported from PyAutoFit (pyautolens.css, copybutton selector). No new Sphinx warnings (130 on main and branch). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_016nhQ8QgLw3SZjRMSaX3v5z
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Brings the PyAutoLens docs in line with PyAutoFit's natural-language-first docs, while keeping the pages about lensing first.
docs/overview/overview_1_start_here.md, not renamed) still opens with strong lensing and the schematic. A new Natural Language or Python section follows:autolens_assistant;docs/index.mdandREADME.md: the "Human-Readable Documentation" and "AI Assistant" sections become Natural Language or Python and Documentation and Examples.nl-promptcontainer is ported from PyAutoFit (docs/_static/pyautolens.css,copybutton_selectorinconf.py). The sharedpyauto.cssis untouched.Companion PRs: the
start_heremode in autolens_assistant and autogalaxy_assistant, the same opening in both workspaces'start_here.py, and the matching PyAutoGalaxy docs PR.Validation
mainand this branch, so no new warnings.#natural-language-or-pythonanchor resolves.Generated by Claude Code