Skip to content

Execute the public guide and explain code samples in docs-local #1554

Open

Description

@doublewhy

Problem

No test runs the code samples in the public guides or the SDL explainer, so samples that no longer work go unnoticed. The docs lane (nox -s docs-local) runs "docs / executable quickstart" (tools/nox_support/test_lanes.py:305-318 on dev a4357f9a), which runs only the three tests in PUBLIC_DOCS_EXAMPLE_TESTS (tools/nox_support/config.py:21-25): the checked-in quickstart scenario, the README quickstart, and the participant-control claim example.

Two broken samples on dev a4357f9a show the gap:

Scope

  • Run the samples in docs/public/guides/ and the SDL samples in docs/explain/ from the docs lane: validate complete SDL scenarios, execute Python samples, and run offline CLI samples, checking the documented outcome.
  • Mark fragments and intentionally invalid samples explicitly so the runner skips or inverts them with a reason.

Done when

  • nox -s docs-local validates every complete SDL sample in docs/public and docs/explain and runs every Python and offline CLI sample in docs/public/guides.
  • Restoring the old python.md rename example or the old Quick Example makes nox -s docs-local fail.
  • Fragments and intentionally invalid samples are marked, and the runner reports why each is skipped.

Related

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions