Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: adapted new structure for states and workflows #674

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

musslick
Copy link
Collaborator

Description

The old state and workflow documentation was obscure, in part because relevant information was hidden in "Examples" sections, and because the information was distributed across section. The PR attempts to consolidate State and Workflow information into one section with the following structure:

  • States and Workflows:
    • Home:
    • AutoRA Variables:
    • States:
      • Overview:
      • Basic Usage:
      • Combining Experimentalists with States:
    • Workflows with States:
      • Overview:
      • Dynamically Altering the State:
    • Workflows for HPCs:
      • "Command Line Interface"
      • "Basic Usage"
      • "Using Cylc"
      • "Using Cylc and Slurm"

Type of change

Delete as appropriate:

  • docs: Documentation only changes

@musslick musslick added documentation Improvements or additions to documentation. enhancement New feature or request. labels Oct 21, 2024
@musslick musslick self-assigned this Oct 21, 2024
@musslick musslick changed the title dos: adapted new structure for states and workflows docs: adapted new structure for states and workflows Oct 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation. enhancement New feature or request.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant