Skip to main content

Review documentation and screenshot evidence

The current documentation audit uses October 13, 2026 main at b4be391, as specified in #324. Capture temporary images under /tmp, store validation screenshots in a gist and link to them from notes/PRs. Do not commit screenshots or put them in developer notes. Internal notes stay outside docs/docs/.

Screenshot register​

EvidencePR/commit and capture dateJurisdiction/scenarioScope and current use
Current finder gallery and manifest#324 audit; b4be391; 2026-10-13Illinois ambiguous name-change search and adult guide; Massachusetts no-guide state, 1280px/390pxFresh anonymous local Chromium captures, configured content/test database. Six HTTP-200 screens, expected headings, no horizontal overflow. No account data, live court calls, filing/payment/email. IL substantive approval remains pending
Existing-case screensPR #319; 719cfed; 2026-10-13 UTCMassachusetts Confirm information, lookup/confirmation, changing inferred court; Vermont OrganizeSynthetic browser/court/storage fixtures. Current labels/path checked against b4be391 templates; not live-provider compatibility
Fees and Review screensPR #319; 719cfed; 2026-10-13 UTCIllinois waiver PDF check, replacement and return-to-Review, desktop/mobileSynthetic; current in-place/review behavior, no actual waiver decision/payment
People and account screensPR #319; 719cfed; 2026-10-13 UTCContact/parties/person/questions/registration; configured jurisdiction fixtures described in sourceSynthetic; state-list fallback notice reflects the fixture, not a promise of live missing court data
Filing tracker screensPR #319; 719cfed; 2026-10-13 UTCTracker sign-in, accepted and returned synthetic filingCurrent status presentation; no live acceptance/rejection callback or email signoff
Earlier preparation corpus#113 validation; 2026-09-30; source version in its validation noteVermont form answers/signature/multiline; synthetic Word/PDF conversionOlder screen UI, including retired Preview step. Reuse only for PDF-content comparison, not current navigation
Earlier docs/static/img/screenshots/01…14 walkthrough imagesCapture version/date/scope not recordedOlder fixed-step walkthroughRemoved from published static assets after a reference audit; preserved in Git history, not current evidence

Three selected PNGs in the current gist are embedded directly in the walkthrough with alt text, scenario captions and fallback source links. They are hosted in the gist, not committed as application/static assets. Their original source commit, capture date and SHA-256 are in its manifest.

The full gist HTML galleries embed PNGs with descriptions/alt text. GitHub shows HTML source: select Raw, save as .html, and open locally to view/download the screenshots. The PR #319 and current finder manifests include hashes and labels. Keep these source links even when embedded images fail to load. Describe the screen and task in alt text; a filename alone is insufficient. Any demo-only restriction needs a visible caption saying it is a demo, plus the actual deployed scope in the register.

Publication checklist​

  1. Reconcile wording/paths with current templates, efile/workflow.py, settings and configuration; check both new/existing cases and conditional detours.
  2. Run manage.py check --fail-level WARNING, relevant existing configuration and matching regressions, and extract_config_text --check from efile_app. For changed application copy, regenerate extraction and review enabled-language catalogs/screenshots/accessibility using the translation workflow.
  3. Check content links, navigation and anchors, then run npm ci and npm run build from docs. Preview the built site and check tables, code blocks, sidebar links and mobile navigation. Do not add internal notes to the sidebar or Docusaurus source tree.
  4. Record commands/results, source versions, screenshot provenance and remaining gaps in the internal review record linked from the maintenance register. Documentation tests do not replace court approval or the release/accessibility matrix in #200.
  5. Have a partner/editor complete one supported configuration change from the wording recipe without reading Python. Record reviewer, task, proposed/source-approved copy, checks, accessible/translated evidence, confusing steps and rollback. This human handover exercise is pending until an external reviewer performs it.

The audit's delivered pages and automated results are recorded in the internal handover note. It records outstanding human approval separately from completed documentation.