Skip to content

Various small proposed improvements#909

Draft
samuel-denton wants to merge 3 commits intocylc:masterfrom
samuel-denton:batch2_thoughts_on_docs
Draft

Various small proposed improvements#909
samuel-denton wants to merge 3 commits intocylc:masterfrom
samuel-denton:batch2_thoughts_on_docs

Conversation

@samuel-denton
Copy link
Contributor

@samuel-denton samuel-denton commented Feb 4, 2026

Requirements check-list

  • I have read CONTRIBUTING.md and added my name as a Code Contributor.

  • Fixed a mistake on the interventions page causing tabs not to sync properly.

  • Adding tabs to the intro page to show different UI types. I find the current image a bit intimidating.

  • Added a note to Basic Cycling - Repeating Workflows to describe the reoccurrence in the example.

…xed a mistake on the interventions page causing tabs to not sync properly.

.. tab-item:: CLI
:sync: gui
:sync: cli
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Small mistake here caused tabs to sync incorrectly.

:alt: A screenshot of the Cylc GUI dashboard.
:width: 75%

.. tab-item:: Tui
Copy link
Contributor Author

@samuel-denton samuel-denton Feb 4, 2026

Choose a reason for hiding this comment

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

I think tabs here are clearer.
The images are just placeholders for now that were found elsewhere in the docs.
Not sure if all 4 tabs are needed or just the 3 with images.

Comment on lines +76 to +82
.. note::

The recurrence term tells Cylc *how often* to repeat the tasks and
dependencies in that block. ``R1`` means *run once* (no cycling),
``P1`` means *repeat every cycle*, ``P2`` means *repeat every other cycle*,
and so on.
Other terms are configurable and are introduced in the next section.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I would like to add a note here explaining why R1 was swapped with P1 and illuding to more complex recurrences in further tutorials.
I am not yet happy with this wording however so will have another think.

from 1.
* ``P1`` is the :term:`recurrence`; a ``P1`` :term:`graph string`
repeats at every integer :term:`cycle point`.
tells Cylc to repeat at every integer :term:`cycle point`.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Minor change to keep consistency with other bullets.

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