docs: document archiving default Document Checker assessments - #1499
Open
juanmleng wants to merge 2 commits into
Open
docs: document archiving default Document Checker assessments#1499juanmleng wants to merge 2 commits into
juanmleng wants to merge 2 commits into
Conversation
The Manage assessments callout said default assessments cannot be edited, only cloned. That is still true of editing, but they can now be archived per organization, so the callout read as though the feature did not exist. Adds an "Archive or restore default assessments" section modelled on "Archive and delete artifact types", since the product mirrors that pattern down to the button labels. No permanent-delete tab: the assessment belongs to ValidMind, so archiving is the only removal. The regulations callout above it is unchanged — default regulations still cannot be edited, and archiving applies to assessments, not regulations. Edited inline rather than through _assessments.qmd, which the administrator-fundamentals training deck also includes; the limitation text lives only on this page, so the deck is unaffected.
juanmleng
marked this pull request as ready for review
September 9, 2026 12:03
The footnote pointed at Manage risk tier templates, a page about creating and configuring them, which is not what a reader needs at that moment — the sentence already tells them to add their own assessment first. The mention itself stays, since it explains why the confirmation lists template names.
cachafla
approved these changes
Sep 9, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What and why?
The Manage assessments section of Customize Document Checker carried this callout:
Editing is still restricted, but default assessments can now be archived for a single organization, so that callout read as though the capability did not exist. This documents it.
Added a new Archive or restore default assessments section, modelled on Archive and delete artifact types in Manage artifact types — the product mirrors that pattern down to the button labels (
Archive Assessment,Yes, Archive Assessment,Restore), so the documentation follows the same shape. There is no permanent-delete tab, because the assessment belongs to ValidMind rather than to the organization: archiving is the only removal available, and it is reversible.The section states the four things a reader needs and cannot infer: an archived assessment stops appearing when running the Document Checker; ValidMind continues to provide it and other organizations are unaffected; assessments already run remain viewable with their findings intact; and archiving can be undone at any time. It also notes that when the archived assessment is the last one available for a regulation or policy, the confirmation lists any risk tier templates that reference it.
The regulations callout above it is unchanged — default regulations still cannot be edited, and archiving applies to assessments rather than to regulations.
How to test
Rendered locally with
skills/validmind-docs-coverage/scripts/render-pages.sh guide/templates/customize-document-checker.qmd. The page and its listing dependency (guide/guides.qmd) both render; the only warnings are the pre-existing unresolvedvalidmind/validmind.qmdAPI-reference links, unchanged by this edit.Verified in the rendered HTML that the new section, its callout, both panel tabs and both confirmation labels are present, and that the two new footnotes resolve rather than emitting literal
[^4]/[^5].Preview links for the changed page to be added once the ready-for-review
validatejob deploys the preview.What needs special review?
Edited inline rather than through
_assessments.qmd. That include is also consumed by theadministrator-fundamentalstraining deck (using-validmind-for-risk-management.qmd), and the RevealJS format has no room for a procedure of this length. The limitation text being corrected lives only on this page — confirmed by searching the site for it — so the training deck is unaffected and its guidance does not become stale.Worth a second opinion on whether the training deck should eventually gain a slide for this. It currently covers adding assessments only, so archiving is a gap there rather than an inaccuracy.
Dependencies, breaking changes, and deployment notes
Documents behavior delivered by paired backend and frontend pull requests that are not yet merged. Do not merge this before they ship, or the documentation will describe an action that is not in the product.
No breaking changes. One page changed, no includes, no configuration, no renames or deletions.
Release notes
Default assessments provided by ValidMind can now be archived so they no longer appear when you run the Document Checker. Use this when your team maintains its own version of a regulatory question set and wants only your version offered. Archiving applies to your organization alone, leaves assessments already run against it untouched, and can be undone at any time from the Archived Assessments section of the regulation or policy. Learn more ...
Checklist