Skip to content

docs: add autolens_assistant prototype callout to README and docs index#530

Merged
Jammy2211 merged 1 commit into
mainfrom
feature/rename-to-autolens-assistant
May 22, 2026
Merged

docs: add autolens_assistant prototype callout to README and docs index#530
Jammy2211 merged 1 commit into
mainfrom
feature/rename-to-autolens-assistant

Conversation

@Jammy2211
Copy link
Copy Markdown
Collaborator

Summary

Adds a prominent but prototype-flagged pointer to the new `PyAutoLabs/autolens_assistant` repo near the top of:

  • `README.md` (between the opening explainer and `## Getting Started`)
  • `docs/index.md` (same placement, using a MyST `{note}` admonition for RTD styling)

The callout explicitly tells users the readthedocs / autolens_workspace / HowToLens links remain the canonical starting points. The assistant is offered only for users who'd like to drive PyAutoLens by natural-language conversation.

Companion PR: PyAutoLabs/autolens_assistant#4

Test plan

  • RTD build renders the `{note}` admonition correctly on docs/index.md.
  • GitHub renders the blockquote-style callout in README.md.
  • Both callouts sit above existing "Getting Started" links, but text is clear that those links remain the recommended path.

🤖 Generated with Claude Code

Adds a prominent but clearly-flagged-as-prototype pointer to the new
PyAutoLabs/autolens_assistant repo near the top of the PyAutoLens README and
the docs landing page. The callout sits above the existing "Getting Started"
links but explicitly tells users the readthedocs/workspace/HowToLens entries
remain the recommended starting points; the assistant is offered only for
users who'd like to drive PyAutoLens by natural-language conversation.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
@Jammy2211 Jammy2211 merged commit 6a80e9e into main May 22, 2026
6 checks passed
@Jammy2211 Jammy2211 deleted the feature/rename-to-autolens-assistant branch May 22, 2026 16:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant