docs: three-ways-to-learn guide + prune stale API-doc references#593
Merged
Conversation
Phase C: add a 'Three Ways to Learn PyAutoLens' subsection (manual navigation / AI chat assistant / fully agentic AI) to the new-user guide and README; reframe autolens_assistant from experimental to a first-class option in README + docs/index. Phase A: prune docs/api/*.rst references to removed API — the OO plotting subsystem (MatPlot2D/Cmap/*Scatter, replaced by the functional plot API), PySwarms searches, PointDict, SetupAdapt->AdaptImages, OverSampling-> OverSampler, and dead linear Chameleon entries. Re-audit clean. Issue #592. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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
Phase C + Phase A of the release-docs polish (#592).
overview_2_new_user_guide.md, and reframesautolens_assistantfrom "experimental / not recommended" to a first-class option inREADME.md+docs/index.md.docs/api/*.rstautosummary entries for removed API — the OO plotting subsystem (MatPlot2D/Cmap/*Scatter, replaced by the functional plot API),PySwarms*,PointDict,SetupAdapt→AdaptImages,OverSampling→OverSampler, and dead linearChameleonentries (kept correctly underlight_and_mass_profiles). Re-audit reports zero broken/missing/duplicate references.The positive functional-API
plot.rstrewrite is filed as a follow-up (PyAutoMinddocs/autolens/plot_rst_functional_api_rewrite.md).Validation checklist (--auto, supervised)
docs/*.rst,docs/*.md,README.md); no public-API/downstream surface.Autonomous run ended at PR-open; merge stays human. Library-first gate: merge this + PyAutoGalaxy before the autolens_workspace PR.
Closes-part-of #592.
🤖 Generated with Claude Code