Skip to content

[SC-16823] Documentation: Document Checker runs, publishing, and artifacts#1434

Merged
cachafla merged 2 commits into
mainfrom
panchicore/sc-16823-document-checker-runs
Jul 24, 2026
Merged

[SC-16823] Documentation: Document Checker runs, publishing, and artifacts#1434
cachafla merged 2 commits into
mainfrom
panchicore/sc-16823-document-checker-runs

Conversation

@panchicore

Copy link
Copy Markdown
Member

Pull Request Description

What and why?

Documents the Modular Document Checker: Runs + Artifacts feature (SC-16823, epic SC-15986).

Before, the docs covered only the one-shot check flow (select regulation → review observations → export). The shipped feature persists every check as a run, so this PR:

  • Adds a new Manage Document Checker runs section to Check documents for compliance covering:
    • Viewing previous runs (My Runs / Organization tabs, private vs. shared visibility)
    • Renaming and deleting private runs (published runs are immutable)
    • Publishing a run to the organization (one-way, permission-gated)
    • Creating artifacts from a published run's questions (pre-filled details, one artifact per question per run, Source traceability on artifact listings and detail pages)
    • Run-scoped PDF export (Export All / Export n selected)
  • Updates the shared _check-documents.qmd include (guide + developer/validator training decks): the results of a check are now saved automatically as a private run, the check button reads Check Document, and export supports selected questions.
  • Fixes the stale Check Validation Document button label in the validator training interactive slide.

The instructions live in a shared source used by the compliance guide and both training decks.

How to test

Rendered every affected page with the repository helper:

skills/validmind-docs-coverage/scripts/render-pages.sh \
  guide/documentation/check-documents-for-compliance.qmd \
  training/developer-fundamentals/finalizing-documentation.qmd \
  training/validator-fundamentals/finalizing-validation-reports.qmd

All three pages render successfully; git diff --check is clean. The pre-existing unresolved validmind/validmind.qmd link warnings are unrelated to this change.

Documentation preview

Review the documentation changes live after the latest validate run completes:

What needs special review?

  • Terminology: the UI publishes a run (Publish to Organization) and then labels it as shared (Shared by, Shared on). The new section uses publish as the verb and published/shared for the state — confirm this reads naturally.
  • The permissions callout for publishing is intentionally vague ("sufficient permissions") because the backend gate is an RBAC action not otherwise documented — confirm this is the right level of detail.
  • No new screenshots are included; the existing Document Checker screenshots still match the check flow. Happy to add run-management screenshots as a follow-up if the docs team wants them.

Dependencies, breaking changes, and deployment notes

Documents behavior delivered by:

All implementation PRs are merged. No breaking changes or special deployment steps.

Release notes

The ValidMind Document Checker now saves every check as a run. Review previous runs for a document, publish a run to share it with your organization, create trackable artifacts directly from a published run's questions, and export any run's saved results to PDF. Learn more about managing Document Checker runs.

Checklist

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

🤖 Generated with Claude Code

Documents the persisted Document Checker runs feature: private/shared
run visibility, viewing previous runs, rename/delete, publishing to the
organization, creating artifacts from published runs with Source
traceability, and run-scoped PDF export.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@panchicore panchicore added the documentation Improvements or additions to documentation label Jul 24, 2026
@CLAassistant

CLAassistant commented Jul 24, 2026

Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
1 out of 2 committers have signed the CLA.

✅ cachafla
❌ panchicore
You have signed the CLA already but the status is still pending? Let us recheck it.

@panchicore panchicore self-assigned this Jul 24, 2026
@github-actions

Copy link
Copy Markdown
Contributor

Validate docs site

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

@cachafla
cachafla merged commit 66644e7 into main Jul 24, 2026
2 of 3 checks passed
@cachafla
cachafla deleted the panchicore/sc-16823-document-checker-runs branch July 24, 2026 20:54
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.

3 participants