Skip to content

docs(examples): unify Linux/Windows run blocks into single code block#24

Merged
galuszkm merged 1 commit into
mainfrom
docs/unify-run-instructions-platform-blocks
Apr 9, 2026
Merged

docs(examples): unify Linux/Windows run blocks into single code block#24
galuszkm merged 1 commit into
mainfrom
docs/unify-run-instructions-platform-blocks

Conversation

@galuszkm

@galuszkm galuszkm commented Apr 9, 2026

Copy link
Copy Markdown
Member

Description

Collapse split ### Linux / macOS + ### Windows subsections into a single bash code block with # Linux / macOS and # Windows PowerShell comment headers, matching the style used in the configuration docs.

Also replace all Windows backslash paths with forward-slash equivalents — PowerShell and Python both accept POSIX paths on Windows, so no separate path variants are needed.

Affects: TEMPLATE_EXAMPLE.md, 02_vars_and_anchors/README.md, 11_multi_file_config/README.md

Related Issues

N/A

Type of Change

  • Documentation update

YAML / API Impact

N/A

Testing

How have you tested the change?

  • I ran uv run just check (lint + type check)
  • I ran uv run just test for overall testing
  • I added or updated tests that prove my fix is effective or my feature works
  • I verified existing examples in examples/ still work

Checklist

  • I have read the CONTRIBUTING document
  • I have updated the documentation accordingly
  • My changes generate no new warnings
  • Any dependent changes have been merged and published

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@galuszkm galuszkm merged commit 37129fd into main Apr 9, 2026
11 checks passed
@galuszkm galuszkm deleted the docs/unify-run-instructions-platform-blocks branch April 9, 2026 19:55
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