Skip to content

docs: artifact field change activity with before/after values [sc-16552] - #1446

Merged
cachafla merged 1 commit into
mainfrom
andres/sc-16552-artifact-activity-docs
Jul 29, 2026
Merged

docs: artifact field change activity with before/after values [sc-16552]#1446
cachafla merged 1 commit into
mainfrom
andres/sc-16552-artifact-activity-docs

Conversation

@cachafla

@cachafla cachafla commented Jul 29, 2026

Copy link
Copy Markdown
Contributor

Pull Request Description

Shortcut: https://app.shortcut.com/validmind/story/16552
Implementation: validmind/backend#3313, validmind/frontend#2675

What and why?

[sc-16552] shipped artifact Activity parity: artifact custom field edits now emit updated-field events with before/after values, shown on the artifact Activity tab, in a per-field change history popover ({{< fa clock >}} on hover), and filterable on record Activity via a new Artifact Fields event category. Restricted artifact fields are hidden from activity for users without access. None of this was documented.

Before: Docs only mentioned coarse "Artifacts added, updated, or removed" on record activity; no artifact-scoped activity coverage at all.
After:

  • guide/validation/update-artifacts.qmd — new View artifact activity section: the Activity tab, View Details before/after expansion, per-field change history on hover, and the permission-redaction limitation.
  • guide/reporting/view-record-activity.qmdArtifact Fields added to both the Event Category and Filter by Value tabsets, with footnotes to the new section.
  • guide/reporting/_view-record-activity-overview.qmd (shared include) — added artifact field changes with before/after values to what record activity tracks.

Pages to review

Updated content appears on these rendered pages (hosted preview, validate ✅):

Page What changed
Update artifacts → View artifact activity New section: Activity tab, View Details before/after values, per-field change history, permission redaction callout
View record activity → Filter record activity Artifact Fields added to both the Event Category and Filter by Value tabsets
View record activity → What is tracked Overview include now lists artifact field changes with before/after values
Training: Developer Fundamentals — Finalizing documentation Slide consuming the updated shared include
Training: Administrator Fundamentals — Organizational oversight Slide consuming the updated shared include
Training: Validator Fundamentals — Finalizing validation reports Slide consuming the updated shared include

How to test

skills/validmind-docs-coverage/scripts/render-pages.sh \
  guide/reporting/view-record-activity.qmd \
  guide/validation/update-artifacts.qmd \
  training/developer-fundamentals/finalizing-documentation.qmd \
  training/administrator-fundamentals/organizational-oversight-reporting.qmd \
  training/validator-fundamentals/finalizing-validation-reports.qmd

All five pages (the two guides plus the three training consumers of the shared include) render cleanly. The only warning (Unable to resolve link target: validmind/validmind.qmd in the validator training deck) is pre-existing and unrelated to these lines.

What needs special review?

  • UI wording is taken from the merged frontend implementation (tab names, View Details, clock icon on field hover). Worth a quick sanity check against the live app.
  • Placement of the new section in update-artifacts.qmd (between commenting and tracking resolution).

Dependencies, breaking changes, and deployment notes

None. Docs-only.

Release notes

Artifact field changes are now fully auditable: view before and after values on the artifact Activity tab, hover over any artifact field to see its change history, and filter record activity by the new Artifact Fields category. Learn more ...

Checklist

  • What and why
  • Screenshots or videos (Frontend)
  • How to test
  • What needs special review
  • Dependencies, breaking changes, and deployment notes
  • Labels applied
  • PR linked to Shortcut
  • Unit tests added (Backend)
  • Tested locally
  • Documentation updated (if required)
  • Environment variable additions/changes documented (if required)

🤖 Generated with Claude Code

sc-16552]

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@cachafla cachafla added the documentation Improvements or additions to documentation label Jul 29, 2026
@cachafla
cachafla marked this pull request as ready for review July 29, 2026 23:14
@github-actions

Copy link
Copy Markdown
Contributor

Validate docs site

✓ INFO: A live preview of the docs site is available — Open the preview

@github-actions

Copy link
Copy Markdown
Contributor

Lighthouse check results

✓ INFO: Average accessibility score is 0.92 (required: ≥0.9) — View the workflow run

Audit mode: changed pages (2 URL(s))

Show Lighthouse scores

Commit SHA: 26b50c7

For a thorough audit, run the Lighthouse check workflow manually (Actions → Lighthouse check → Run workflow) with depth 0–2, or add the lighthouse:full label for depth 2 on the next validate run.

Page Accessibility Performance Best Practices SEO
/guide/reporting/view-record-activity.html 0.92 0.73 1.00 0.82
/guide/reporting/view-record-activity.html 0.92 0.73 1.00 0.82
/guide/validation/update-artifacts.html 0.92 0.77 1.00 0.82
/guide/validation/update-artifacts.html 0.92 0.68 1.00 0.82
/guide/reporting/view-record-activity.html 0.92 0.71 1.00 0.82
/guide/validation/update-artifacts.html 0.92 0.77 1.00 0.82

@cachafla

Copy link
Copy Markdown
Contributor Author

Preview links (validate ✅):

Training decks consuming the shared include (updated slide):

@cachafla cachafla left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved.

@cachafla
cachafla enabled auto-merge July 29, 2026 23:44
@cachafla
cachafla disabled auto-merge July 29, 2026 23:44
@cachafla
cachafla merged commit 8b704ca into main Jul 29, 2026
11 checks passed
@cachafla
cachafla deleted the andres/sc-16552-artifact-activity-docs branch July 29, 2026 23:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant