Skip to content

docs: All workflows timeline#1335

Merged
validbeck merged 19 commits into
mainfrom
beck/sc-15652/documentation-workflows-enhanced-global-view
May 21, 2026
Merged

docs: All workflows timeline#1335
validbeck merged 19 commits into
mainfrom
beck/sc-15652/documentation-workflows-enhanced-global-view

Conversation

@validbeck
Copy link
Copy Markdown
Collaborator

@validbeck validbeck commented May 19, 2026

Pull Request Description

What and why?

sc-15652

Docs update for the following features:

  • View all workflows in a cohesive timeline
  • Save organization views on inventory, artifacts, and workflows with the proper permissions

How to test

Click on the live previews:

page change notes
Working with workflows New section: View all workflow executions "How do I create effective filters?" toggle should only show the workflow Inventory filter options.
Manage workflows Wording updated to indicate that this is about working with workflows on specific records or artifacts. "Review workflow histories" section now has a footnote out to View all workflow executions.
Customize inventory layout Edited the information on saved views to accomodate for organization views.
Customize artifact layouts Same as previous line.
Work with filters "Workflow VIew Filters" added to step 2. This is the same info that shows up in the toggle in Working with workflows.
Organizational Oversight & Reporting Added two slides: 1. Review workflow executions, 2. View all workflow executions Click the tabs to view more info, then click the > to review the next slide (you'll need to be logged in to ValidMind through the training to view the platform in the background).

What needs special review?

n/a

Dependencies, breaking changes, and deployment notes

n/a

Release notes

Covered by:

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

PR Summary

This PR significantly refactors the documentation related to managing custom views across inventory, artifact, and workflow sections. The changes include:

  • Removal of redundant, duplicated instructions from individual files and the consolidation of view management guidance into shared include files (_personal-views.qmd and _organization-views.qmd).
  • Updates to the inventory-related documentation to clarify the difference between personal and organization views, and updated instructions for saving, editing, and removing views.
  • Improvements in the workflow documentation including clarification of the terminology from "Review workflows" to "Review workflow executions", and the addition of a prerequisites section to ensure users are aware of permissions and setup requirements before proceeding.
  • Modifications to the artifact documentation that streamline instructions by integrating shared components, thus reducing repetitive content while ensuring consistency across sections.
  • Minor formatting updates in the filters section and in the presentation CSS (slides.scss) to adjust the rendering of keyboard hints in reveal.js slides.

Overall, the PR improves the modularity and consistency of the documentation and makes it easier for users to follow procedures related to managing views and interacting with workflows.

Test Suggestions

  • Verify that each guide page renders correctly with the new shared components included in the inventory, artifact, and workflow sections.
  • Check that all links, icons, and callout boxes display properly and navigate to the intended targets (e.g., permissions management, workflow execution details).
  • Test the responsive behavior and styling of the updated CSS rules for kbd elements in reveal.js presentations.
  • Review navigation between personal and organization view management pages to ensure smooth integration of content.

@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

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

Show Lighthouse scores

Folder depth level checked: 0

Commit SHA: bd49beb

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.68 1.00 0.82
/get-started/get-started.html 0.85 0.71 1.00 0.73
/guide/guides.html 0.85 0.69 1.00 0.82
/index.html 0.93 0.67 1.00 0.82
/releases/all-releases.html 0.86 0.69 1.00 0.73
/support/support.html 0.91 0.68 1.00 0.82
/training/training.html 0.85 0.62 0.96 0.73

Copy link
Copy Markdown
Contributor

@cachafla cachafla left a comment

Choose a reason for hiding this comment

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

Awesome 👍

@validbeck validbeck merged commit fdbf74f into main May 21, 2026
23 checks passed
@validbeck validbeck deleted the beck/sc-15652/documentation-workflows-enhanced-global-view branch May 21, 2026 20:57
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