Skip to content

Rename cookbook to how-to-guides - #2341

Merged
hannahbaumann merged 2 commits into
docs/howto-runfrom
docs/rename-cookbook
Nov 9, 2026
Merged

hannahbaumann merged 2 commits into
docs/howto-runfrom
docs/rename-cookbook

Conversation

@hannahbaumann

@hannahbaumann hannahbaumann commented Nov 6, 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: [If yes, please provide details here]

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

Copy link
Copy Markdown
Contributor Author

This also requires changing all the relevant links in the Examplenotebook which is done here: OpenFreeEnergy/ExampleNotebooks#356

@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.

lgtm!

@hannahbaumann
hannahbaumann merged commit 05c899e into docs/howto-run Nov 9, 2026
3 checks passed
@hannahbaumann
hannahbaumann deleted the docs/rename-cookbook branch November 9, 2026 07:45
hannahbaumann added a commit that referenced this pull request Nov 9, 2026
* Reorganize How-to and user guide execution

* Fix links

* More fixes

* More changes

* some more fixes

* Update docs/guide/execution/quickrun_execution.rst

Co-authored-by: Alyssa Travitz <31974495+atravitz@users.noreply.github.com>

* Update docs/guide/execution/quickrun_execution.rst

Co-authored-by: Alyssa Travitz <31974495+atravitz@users.noreply.github.com>

* Update docs/guide/execution/quickrun_execution.rst

Co-authored-by: Alyssa Travitz <31974495+atravitz@users.noreply.github.com>

* Update docs/cookbook/resume_quickrun.rst

Co-authored-by: Alyssa Travitz <31974495+atravitz@users.noreply.github.com>

* Update docs/cookbook/resume_quickrun.rst

Co-authored-by: Alyssa Travitz <31974495+atravitz@users.noreply.github.com>

* Update docs/cookbook/resume_quickrun.rst

Co-authored-by: Alyssa Travitz <31974495+atravitz@users.noreply.github.com>

* Update docs/cookbook/resume_quickrun.rst

Co-authored-by: Alyssa Travitz <31974495+atravitz@users.noreply.github.com>

* Update docs/cookbook/run_on_slurm.rst

Co-authored-by: Alyssa Travitz <31974495+atravitz@users.noreply.github.com>

* Apply batched suggestions from code review

Co-authored-by: Alyssa Travitz <31974495+atravitz@users.noreply.github.com>

* address review comments

* Rename cookbook to how-to-guides (#2341)

* Rename cookbook to how-to-guides

* some more changes

* Update docs/guide/execution/index.rst

Co-authored-by: Alyssa Travitz <31974495+atravitz@users.noreply.github.com>

* test out

---------

Co-authored-by: Alyssa Travitz <31974495+atravitz@users.noreply.github.com>
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