Vetrix Docs

User Documentation Screenshot Assets

Image assets for the Vetrix user documentation set. This directory holds no prose: nothing here is a page to read, and every file is an evidence capture that a documentation page in this set embeds or cites.

Audience: contributors adding, refreshing, or retiring an evidence image.

A separate asset directory with the same name exists in the repo-root user documentation tree. It is a different set with different contents; the two are never cross-referenced.

Contents

The directory holds one subdirectory and no loose files.

  • pipeline-proof/ — captures of the pipeline detail page's Coverage Report panel, used as evidence for what the panel renders with and without a coverage artifact.

pipeline-proof/ currently holds exactly two images:

  • coverage-summary-empty.png — the Coverage Report empty state, showing the "No coverage data for this pipeline" message with no table and no HTML report link.
  • coverage-summary-populated.png — the populated state, showing the total percentage, a sortable per-package table, and the header link to the full HTML report.

Both files are placeholder renderings that stand in for real product captures until a browser-automation run replaces them.

What the evidence supports

No page embeds either image yet. Both depict the two states described under "What you'll see" in Surfacing pipeline coverage, which is the page they are captured for.

Contribution convention

  • Group images in a subdirectory named for the claim they support, one subdirectory per theme; do not add loose image files at this level.
  • Name a file <subject>-<state>.png in kebab-case, so that the empty and populated variants of one panel sort together.
  • Embed an image with a path relative to the embedding page — a page in cicd/ reaches the empty-state capture at ../screenshots/pipeline-proof/coverage-summary-empty.png.
  • Record every new image in the contents list above, including the state or condition it captures, so an unreferenced asset is still traceable.
  • Keep this page the only index for the directory: subdirectories here are mapped from here and do not carry their own README.md.