Skip to content

docs: Organization wide default tracking changes in content blocks #1202

Merged
validbeck merged 4 commits intomainfrom
beck/sc-14949/documentation-org-wide-setting-to-enable
Mar 5, 2026
Merged

docs: Organization wide default tracking changes in content blocks #1202
validbeck merged 4 commits intomainfrom
beck/sc-14949/documentation-org-wide-setting-to-enable

Conversation

@validbeck
Copy link
Collaborator

@validbeck validbeck commented Mar 4, 2026

Pull Request Description

What and why?

sc-14949

Documentation for the administrative ability to enable tracking changes by default in content blocks in documents.

How to test

Click on the live previews and compare the changes:

page OLD NEW
Managing your organization > Manage document defaults n/a, net-new section Screenshot 2026-03-04 at 12 36 27 PM
Collaborate with others > Tracking changes Screenshot 2026-03-04 at 12 00 17 PM Screenshot 2026-03-04 at 12 37 06 PM

What needs special review?

n/a

Dependencies, breaking changes, and deployment notes

n/a

Release notes

Covered in https://github.com/validmind/frontend/pull/2225.

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

github-actions bot commented Mar 4, 2026

PR Summary

This PR updates the documentation to better guide users on managing the default track changes setting for organization documents. In the organization configuration guide, a new section titled "Manage document defaults" has been added. This section instructs users on toggling the default behavior of enabling track changes for all content blocks. Additionally, a new footnote reference has been included to support this update.

In the model documentation guide, a callout has been added to alert administrators that they have the option to enable track changes by default. The callout also clarifies that users with write permissions can disable track changes individually during an editing session. A minor update was made to adjust the revision history reference footnotes to maintain consistency across documents.

Overall, the functional changes focus on ensuring that users are aware of the configurable track changes default and provide guidance on how to manage it within their organization.

Test Suggestions

  • Manually verify that the new 'Manage document defaults' section is visible and correctly formatted within the organization's settings documentation.
  • Check that the new callout in the model documentation properly renders and provides the correct information regarding track changes.
  • Click all the updated footnote and reference links (e.g., the link for 'Collaborate with others' and the one for 'Managing your organization') to ensure they point to the correct sections.

@github-actions
Copy link
Contributor

github-actions bot commented Mar 4, 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 Mar 4, 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: a283c92

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.60 1.00 0.82
/get-started/get-started.html 0.85 0.69 1.00 0.73
/guide/guides.html 0.85 0.69 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.62 1.00 0.82
/training/training.html 0.85 0.67 0.96 0.73

@validbeck validbeck requested review from cachafla and nrichers March 4, 2026 20:37
Copy link
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 df2cbed into main Mar 5, 2026
20 checks passed
@validbeck validbeck deleted the beck/sc-14949/documentation-org-wide-setting-to-enable branch March 5, 2026 02:39
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