Skip to content

Add CI smoke checks for tutorial and example portability #12

@MitchellAcoustics

Description

@MitchellAcoustics

Summary

The project should add CI smoke checks for tutorials/examples so non-portable docs content is caught automatically.

Problem

Machine-local paths slipped into committed docs/tutorials and were not caught by the current automation. The docs build succeeds, but it does not currently protect against broken or non-portable example content.

Evidence

Recent docs/tutorial content included local absolute paths in committed files.

Proposed work

  • Add a lightweight CI smoke check for docs/tutorial/example portability.
  • At minimum, fail on machine-local path patterns like /Users/, OneDrive, and obsolete repo paths.
  • Optionally add a stricter tutorial/example validation target in CI.

Acceptance criteria

  • CI fails when machine-local paths or similarly non-portable example references are introduced.
  • The check is documented and runs as part of normal PR validation.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions