Skip to content

Reorganize How-to and user guide execution - #2339

Merged
hannahbaumann merged 19 commits into
mainfrom
docs/howto-run
Nov 9, 2026
Merged

hannahbaumann merged 19 commits into
mainfrom
docs/howto-run

Conversation

@hannahbaumann

@hannahbaumann hannahbaumann commented Nov 5, 2026 •

Copy link
Copy Markdown
Contributor

Description:

LLM / AI generated code disclosure

LLMs or other AI-powered tools (beyond simple IDE use cases) were used in this contribution:

  • No
  • Yes: claude opus 5.5 was used in a back and forth to move content from the user guide over to the how-to and ammend the content where necessary, updating links,...

Checklist

  • Read the AI Policy and filled in the AI-generated code disclosure.
  • Adhered to the contribution guidelines
  • All new code is appropriately documented (user-facing code must have complete docstrings).
  • Ran pre-commit: you can run pre-commit locally or comment on this PR with pre-commit.ci autofix.
  • Added a news entry, or the changes are not user-facing.

Manual Tests: these are slow so don't need to be run every commit, only before merging and when relevant changes are made (generally at reviewer-discretion).

Developers certificate of origin

@hannahbaumann
hannahbaumann marked this pull request as ready for review November 5, 2026 13:05

@atravitz atravitz left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I really like the structure of this, but I have edits for content!

Comment thread docs/how_to_guides/index.rst Resolved
Comment thread docs/cookbook/index.rst Resolved
Comment thread docs/how_to_guides/index.rst Resolved
Comment thread docs/how_to_guides/index.rst Resolved
Comment thread docs/cookbook/index.rst Resolved
hannahbaumann and others added 10 commits November 6, 2026 11:40
Co-authored-by: Alyssa Travitz <31974495+atravitz@users.noreply.github.com>
Co-authored-by: Alyssa Travitz <31974495+atravitz@users.noreply.github.com>
Co-authored-by: Alyssa Travitz <31974495+atravitz@users.noreply.github.com>
Co-authored-by: Alyssa Travitz <31974495+atravitz@users.noreply.github.com>
Co-authored-by: Alyssa Travitz <31974495+atravitz@users.noreply.github.com>
Co-authored-by: Alyssa Travitz <31974495+atravitz@users.noreply.github.com>
Co-authored-by: Alyssa Travitz <31974495+atravitz@users.noreply.github.com>
Co-authored-by: Alyssa Travitz <31974495+atravitz@users.noreply.github.com>
Co-authored-by: Alyssa Travitz <31974495+atravitz@users.noreply.github.com>

@atravitz atravitz left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this looks great! just one tiny nitpick, so approving now.

Comment thread docs/how_to_guides/index.rst Resolved
Comment thread docs/how_to_guides/index.rst Resolved
Comment thread docs/cookbook/resume_quickrun.rst Resolved
Comment thread docs/guide/execution/index.rst Resolved
Comment thread docs/guide/execution/index.rst Resolved
hannahbaumann and others added 3 commits November 9, 2026 08:45
* Rename cookbook to how-to-guides

* some more changes
Co-authored-by: Alyssa Travitz <31974495+atravitz@users.noreply.github.com>
@hannahbaumann
hannahbaumann merged commit 815ae47 into main Nov 9, 2026
3 checks passed
@hannahbaumann
hannahbaumann deleted the docs/howto-run branch November 9, 2026 08:40
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.

2 participants