Skip to content

docs: Models > Records — Reporting, Monitoring, Attestation#1359

Open
validbeck wants to merge 13 commits into
mainfrom
beck/sc-15995/documentation-primary-record-types-phase
Open

docs: Models > Records — Reporting, Monitoring, Attestation#1359
validbeck wants to merge 13 commits into
mainfrom
beck/sc-15995/documentation-primary-record-types-phase

Conversation

@validbeck
Copy link
Copy Markdown
Collaborator

@validbeck validbeck commented May 28, 2026

Pull Request Description

What and why?

sc-15995

Important

THIS PR IS NOT EXHAUSTIVE DUE TO THE LARGE SCOPE OF WORK. Refer to "What needs special review?" for follow-on updates.

How to test

Click on the live previews and verify everything looks OK:

Reporting

OLD NEW
Working with analytics Working with analytics
View report data View report data
Export analytics Export analytics
Generating exports Generating exports
Export inventory Export inventory
Export documents Export documents
Export artifacts Export artifacts

Monitoring

OLD NEW
Ongoing monitoring Ongoing monitoring
Enable monitoring Enable monitoring
Review monitoring results Review monitoring results
Work with metrics over time Work with metrics over time
Set thresholds and alerts Set thresholds and alerts

Attestation

OLD NEW
Working with attestations Working with attestations
Manage attestations Manage attestations
Submit attestations Submit attestations
Review attestations Review attestations
Approve attestations Approve attestations

Training — Adminstrator Fundamentals

OLD NEW
Onboarding Your Organization Onboarding Your Organization
Customizing Your Inventory Customizing Your Inventory
Using ValidMind for Risk Management Using ValidMind for Risk Management
Organizational Oversight & Reporting Organizational Oversight & Reporting

What needs special review?

Still one more update that needs to be made to the docs as this new functionality is pretty all-encompassing.

What's not covered and will be in a future Story (not using the sc link so the GitHub integration doesn't think these Stories are under review due to this PR being linked):

Dependencies, breaking changes, and deployment notes

n/a

Release notes

n/a

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)

@validbeck validbeck self-assigned this May 28, 2026
@validbeck validbeck added the internal Not to be externalized in the release notes label May 28, 2026
@github-actions
Copy link
Copy Markdown
Contributor

PR Summary

This PR makes extensive textual updates across multiple documentation files to standardize terminology by replacing instances of 'model' with 'record' (or variations thereof). The changes are applied to guides, tutorials, and reporting documents, affecting sections on attestation, monitoring, reporting, inventory management, and training. The updates ensure consistency in how data entities are referenced across the platform, aligning terminology with the updated product focus. No functional or code logic changes are introduced—only manual textual revisions and user interface label modifications to improve clarity and coherence in documentation.

Test Suggestions

  • Manually review the updated pages (attestation, monitoring, reporting, inventory, and training guides) for correct and consistent replacement of 'model' with 'record'.
  • Verify that UI elements and links (e.g., dashboards, navigation menus, and dropdowns) display the new terminology correctly.
  • Check that the documentation samples and code snippets continue to work as expected without reference errors.
  • Confirm that all embedded variable links and callouts still render correctly after the text changes.

@github-actions
Copy link
Copy Markdown
Contributor

Validate docs site

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

@validbeck validbeck requested review from even-steven and jamadriz May 28, 2026 20:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

internal Not to be externalized in the release notes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant