Skip to content

docs: Settings redesign / overhaul#1266

Open
validbeck wants to merge 44 commits intomainfrom
beck/sc-15149/documentation-permissions-redesign-for-roles
Open

docs: Settings redesign / overhaul#1266
validbeck wants to merge 44 commits intomainfrom
beck/sc-15149/documentation-permissions-redesign-for-roles

Conversation

@validbeck
Copy link
Copy Markdown
Collaborator

@validbeck validbeck commented Apr 3, 2026

Pull Request Description

What and why?

sc-15149

We updated the Settings UI ... all of it. I have updated ALL the docs with the exception of what is noted in the special review section.

How to test

Look at the git diff and review the changes on these pages:

Get Started

Guides

Attestation

Configuration

Integrations

Workflows

Model Inventory

Templates

Model Documentation

Model Validation

Reporting

ValidMind Library

Training > Administrator Fundamentals

What needs special review?

Dependencies, breaking changes, and deployment notes

Some descriptions rely on https://github.com/validmind/frontend/pull/2393 being merged in.

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

github-actions bot commented Apr 3, 2026

PR Summary

This PR introduces extensive textual and interface updates aimed at improving the clarity, consistency, and user guidance across the platform’s documentation and settings pages. The changes include:

  • Updated navigation instructions to reflect new iconography and labels. For example, references to the Documents section now use the {{< fa file >}} icon, and Governance-related settings use the {{< fa shield >}} icon.
  • Improved button and confirmation dialogue texts. Several steps now require explicit actions such as “Yes, Delete X” or “Save Changes” to better confirm irreversible actions.
  • Refinements to role, group, and workflow configuration instructions. Details now specify clearer step-by-step procedures (e.g., changing from “Add New Business Unit” to “Add Business Unit” and clarifying role assignment steps).
  • Streamlining of content in both visible and hidden sections to ensure that user tasks are described in a more intuitive and consistent manner across various guides (e.g., in model inventory, artifact management, workflows, templates, and user access management).

These editorial and UX improvements help guide users more effectively while using the application’s administrative and configuration tools. There are no business logic or underlying functionality changes, so the focus remains on enhancing user comprehension and interface consistency.

Test Suggestions

  • Manually verify that all updated navigation labels and icons (e.g., {{< fa file >}}, {{< fa shield >}}, {{< fa circle-user >}}) are correctly rendered in the corresponding settings menus.
  • Confirm that confirmation dialogues now display the updated text (e.g., 'Yes, Delete...' buttons) when performing delete actions.
  • Perform a walkthrough of key administrative flows (e.g., user role assignment, workflow configuration, template management) to ensure that the updated instructions match the UI behavior.
  • Run any screenshot-based UI tests or regression tests to ensure that no unintended UI layout changes occurred due to text modifications.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 3, 2026

Validate docs site

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

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