This skill should be used when the user asks to "add an example", "write a tutorial", "document a new workflow example", or when creating a new worked example under `docs/source/examples/`.
The English summary is being prepared. Showing the original description.
Review the instructions the agent will receive before you install.
Creates a worked example under docs/source/examples/<name>/.
Load StreamFlow Documentation for general RST style rules.
docs/source/examples/<name>/
├── <name>.rst # tutorial · streamflow.yml # primary config
├── cwl/main.cwl · config.yml · clt/*.cwl
├── data/ # input files
└── environment/<connector>/
Intro → Concepts covered → Prerequisites → Project layout → Steps
(source files, CWL tools, Workflow, inputs, environment, streamflow.yml)
→ Run the workflow → Expected output → Alternative deployments → Troubleshooting
.. literalinclude:: for file content; .. code-block:: only when
the file contains values the user must substitute.:emphasize-lines: for lines that differ from a previous listing.data/ is at the project root; config.yml uses ../data/<file>.streamflow-k8s.yml) must not appear in
the tutorial — only streamflow.yml is visible to the reader... _Alternative deployments: section.docs/source/index.rst — add to the Examples toctree:
examples/<name>/<name>.rst
docs/tests/test_examples.py — one function per streamflow*.yml:
@pytest.mark.asyncio
async def test_<name>_<backend>() -> None:
"""Run the <Name> example using the <Backend> backend."""
await _run(
pathlib.Path(__file__).parent.parent
/ "source" / "examples" / "<name>" / "streamflow[-<backend>].yml"
)
Naming: test_<example>_<backend> (e.g. test_mpi_kubernetes).
Verify with make test from docs/.
No reviews yet. Tell others what you thought.
No login needed. Share how it worked for you, ask a question, or note where it did not run.
No comments yet. Be the first to write one.
This skill should be used when the user asks to "update the changelog", "add a changelog entry", "write a CHANGELOG entry", or when preparing a git commit in StreamFlow that requires updating the `## [Unreleased]` section of `CHANGELOG.md`.
The English summary is being prepared. Showing the original description.
This skill should be used when the user asks to "add docstrings", "write error handling", "use naming conventions", "handle exceptions", or when writing new Python code for StreamFlow that requires docstring format, naming conventions, exception handling, or async cleanup patterns.
The English summary is being prepared. Showing the original description.
This skill should be used when the user asks to "write documentation", "add a doc page", "update RST files", "add a tutorial", or when writing or editing Sphinx RST documentation for StreamFlow.
The English summary is being prepared. Showing the original description.
This skill should be used when the user asks to "write a commit message", "create a commit", "format a commit", "what commit type to use", or when preparing changes for a git commit in StreamFlow. Provides commit message format, type conventions, and examples.
The English summary is being prepared. Showing the original description.
This skill should be used when the user encounters "no-untyped-def" mypy errors, asks to "fix no-untyped-def errors", "add type annotations to functions", or mentions "Function is missing a type annotation". Provides specific workflow for fixing missing type annotations while respecting forbidden type constraints.
The English summary is being prepared. Showing the original description.
This skill should be used when the user asks to "fix mypy errors", "add type annotations", "fix type checking", "resolve no-untyped-def", "fix mypy type errors", or when working with type hints while respecting StreamFlow's forbidden type constraints (no Any, dict[str, Any], etc.).
The English summary is being prepared. Showing the original description.