Skip to content

Conversation

@validbeck
Copy link
Collaborator

@validbeck validbeck commented Feb 3, 2026

Pull Request Description

What and why?

sc-14229

There was some missing verbiage in the docs surrounding conditions for PDF uploads for documentation. I've added this information in as a patch as this functionality has been out for quite a while.

How to test

Click on the links for the live previews and compare the changes in the screencaps.

page OLD NEW
Manage model documents Screenshot 2026-02-03 at 2 22 58 PM Screenshot 2026-02-03 at 2 23 06 PM
Working with model documentation Screenshot 2026-02-03 at 2 24 08 PM Screenshot 2026-02-03 at 2 24 26 PM
View documentation guidelines Screenshot 2026-02-03 at 2 25 13 PM Screenshot 2026-02-03 at 2 25 17 PM
Work with content blocks Screenshot 2026-02-03 at 2 25 54 PM Screenshot 2026-02-03 at 2 26 01 PM
Work with test results Screenshot 2026-02-03 at 2 26 36 PM Screenshot 2026-02-03 at 2 26 40 PM
Assign documentation section statuses Screenshot 2026-02-03 at 2 27 20 PM Screenshot 2026-02-03 at 2 27 24 PM
Collaborate with others Screenshot 2026-02-03 at 2 28 07 PM Screenshot 2026-02-03 at 2 28 12 PM
Preparing validation reports Screenshot 2026-02-03 at 2 29 08 PM Screenshot 2026-02-03 at 2 29 12 PM
Review model documentation Screenshot 2026-02-03 at 2 56 57 PM Screenshot 2026-02-03 at 2 57 06 PM
Assess compliance Screenshot 2026-02-03 at 2 29 56 PM Screenshot 2026-02-03 at 2 30 00 PM
Using ValidMind for Model Development Screenshot 2026-02-03 at 2 31 28 PM Screenshot 2026-02-03 at 2 31 32 PM
Using ValidMind for Model Validation Screenshot 2026-02-03 at 2 31 28 PM Screenshot 2026-02-03 at 2 31 32 PM

What needs special review?

n/a

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 Feb 3, 2026
@validbeck validbeck added the internal Not to be externalized in the release notes label Feb 3, 2026
@github-actions
Copy link
Contributor

github-actions bot commented Feb 3, 2026

PR Summary

This pull request updates several documentation pages to clearly communicate that PDF uploads are treated as static documents. The changes introduce visually prominent callout boxes in various sections of the documentation (such as Document Overview, section statuses, collaboration, content block handling, test results, model editing, compliance assessments, and template management) to inform users that only documentation generated via the designated developer tool or created in the platform supports dynamic features such as editing, commenting, or linking artifacts.

These modifications ensure that users are aware of system limitations regarding PDF uploads and help prevent confusion regarding available functionalities. The callouts serve to highlight that PDF uploads are immutable once uploaded and do not support dynamic updates or interactions. Overall, the changes improve clarity and guide the users on which document types support enhanced functionality.

Test Suggestions

  • Verify that each documentation page displays the new callout block with the correct title and message.
  • Manually navigate through the affected pages to ensure that the callout content appears in the correct context and does not interfere with other page elements.
  • Test the related dynamic functionalities (e.g., document editing, status assignment, collaboration features) to confirm that restrictions apply correctly to PDF-uploaded documents.
  • Check responsiveness and visual styling of the callouts across different devices and browsers.

@github-actions
Copy link
Contributor

github-actions bot commented Feb 3, 2026

Validate docs site

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

@github-actions
Copy link
Contributor

github-actions bot commented Feb 3, 2026

Lighthouse check results

⚠️ WARN: Average accessibility score is 0.87 (required: >0.9) — Check the workflow run

Show Lighthouse scores

Folder depth level checked: 0

Commit SHA: a392fda

Modify the workflow to check a different depth:

  • 0: Top-level navigation only — /index.html, /guide/guides.html, ...
  • 1: All first-level subdirectories — /guide/.html, /developer/.html, ...
  • 2: All second-level subdirectories — /guide/attestation/*.html, ...
Page Accessibility Performance Best Practices SEO
/developer/validmind-library.html 0.85 0.66 1.00 0.82
/get-started/get-started.html 0.85 0.68 1.00 0.73
/guide/guides.html 0.85 0.68 1.00 0.82
/index.html 0.93 0.66 1.00 0.82
/releases/all-releases.html 0.86 0.68 1.00 0.73
/support/support.html 0.91 0.65 1.00 0.82
/training/training.html 0.85 0.66 0.96 0.73

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.

2 participants