docs(va): in-report screenshots for the mapping and the banner #30

Merged
allan merged 2 commits from docs/va-in-report-images into main 2026-10-29 14:38:26 +00:00
Collaborator

Every image on the embed page now shows the report around the editor. The two remaining sandbox captures are replaced with in-report ones, and the third is removed because it cannot honestly be re-shot yet.

Images

  • img/va-parmap-filtered.png - report viewer, prompt DROPDOWN_TAB1 (relabelled on the report so it matches no column) and SOME_DATE, with
    FILTER : ( ( SOME_DROPDOWN = 'Option 1' AND SOME_DATE = '01JUL1960'd ) ) over 21 rows. The mapped parameter is filtering SOME_DROPDOWN, which is not its name.
  • img/va-parmap-banner.png - the same object with a malformed entry (va_parmap=SOME_DATE, no hyphen): the warning banner sits above a populated, filtered grid, and no request error is raised.
  • img/va-parmap-transform.png - removed. The deployment these came from predates the ADD/RANGE work, so there is no in-report picture of a date anchor to take; a sandbox capture would be the one image on the page without the report around it. The section keeps the syntax, anchors and examples table.

Prose

The mapping caption now says the date parameter beside it is name-matched, which is what the picture shows.

Verification

  • mkdocs build --clean completes; each of the four remaining images is referenced once, va-parmap-transform.png is not in the build.
  • Both new PNGs were read back after capture: VA's blue bar present, banner or filter text matches the prose, grid populated, no modal, nothing clipped.

Why the banner image uses a malformed entry

The obvious way to photograph the banner is a mapping to a column that does not exist (va_parmap=SOME_DATE-NOT_A_COLUMN). That case raises an abort modal over the grid as well as the banner, which is filed as a bug (dc/dc#404) rather than photographed as if it were the intended state. The malformed-entry case shows the banner with a populated grid and no request error, so that is the one used.

Every image on the embed page now shows the report around the editor. The two remaining sandbox captures are replaced with in-report ones, and the third is removed because it cannot honestly be re-shot yet. ## Images - `img/va-parmap-filtered.png` - report viewer, prompt `DROPDOWN_TAB1` (relabelled on the report so it matches no column) and `SOME_DATE`, with `FILTER : ( ( SOME_DROPDOWN = 'Option 1' AND SOME_DATE = '01JUL1960'd ) )` over 21 rows. The mapped parameter is filtering `SOME_DROPDOWN`, which is not its name. - `img/va-parmap-banner.png` - the same object with a malformed entry (`va_parmap=SOME_DATE`, no hyphen): the warning banner sits above a populated, filtered grid, and no request error is raised. - `img/va-parmap-transform.png` - **removed**. The deployment these came from predates the `ADD`/`RANGE` work, so there is no in-report picture of a date anchor to take; a sandbox capture would be the one image on the page without the report around it. The section keeps the syntax, anchors and examples table. ## Prose The mapping caption now says the date parameter beside it is name-matched, which is what the picture shows. ## Verification - `mkdocs build --clean` completes; each of the four remaining images is referenced once, `va-parmap-transform.png` is not in the build. - Both new PNGs were read back after capture: VA's blue bar present, banner or filter text matches the prose, grid populated, no modal, nothing clipped. ## Why the banner image uses a malformed entry The obvious way to photograph the banner is a mapping to a column that does not exist (`va_parmap=SOME_DATE-NOT_A_COLUMN`). That case raises an abort modal over the grid as well as the banner, which is filed as a bug (dc/dc#404) rather than photographed as if it were the intended state. The malformed-entry case shows the banner with a populated grid and no request error, so that is the one used.
hermes added 2 commits 2026-10-29 14:25:39 +00:00
Captured from the report viewer at 1920x1100: two prompts (a value list and a
date), 21 rows returned by
FILTER : ( ( SOME_DROPDOWN = 'Option 1' AND SOME_DATE = '01JUL1960'd ) ).

- drops the header/FILTER crop, which had no VA chrome, and the sentence it
  illustrated
- drops the "single row it matches" wording, which no longer describes the
  picture
- documents the date clause as a code block instead of a second image
Both images on the embed page were still captured from a local sandbox with the
editor as the top-level document, so neither showed the report around it.

- va-parmap-filtered.png: the report viewer, prompt DROPDOWN_TAB1 (relabelled on
  the report, not matching any column) and SOME_DATE, with
  FILTER : ( ( SOME_DROPDOWN = 'Option 1' AND SOME_DATE = '01JUL1960'd ) ) over
  21 rows - the mapped parameter filtering a column that is not its name
- va-parmap-banner.png: the same object with a malformed entry
  (va_parmap=SOME_DATE, no hyphen), showing the warning banner over a populated,
  filtered grid

The caption for the mapping now says the date parameter beside it is
name-matched, which is what the picture shows.

va-parmap-transform.png is removed rather than replaced: the deployment used for
these captures predates the ADD/RANGE work, so there is no honest in-report
picture of a date anchor to take, and a sandbox capture would be the one image on
the page without the report around it. The section keeps the syntax, the anchors
and the examples table.
allan merged commit 428e8e7fa1 into main 2026-10-29 14:38:26 +00:00
allan deleted branch docs/va-in-report-images 2026-10-29 14:38:26 +00:00
Sign in to join this conversation.
No Reviewers
No labels
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: dc/docs.datacontroller.io#30