Skip to content

docs: Edit document template outline directly from document#1233

Merged
validbeck merged 7 commits into
mainfrom
beck/sc-14815/documentation-document-outline-permissions
Mar 24, 2026
Merged

docs: Edit document template outline directly from document#1233
validbeck merged 7 commits into
mainfrom
beck/sc-14815/documentation-document-outline-permissions

Conversation

@validbeck
Copy link
Copy Markdown
Collaborator

@validbeck validbeck commented Mar 23, 2026

Pull Request Description

What and why?

sc-14815

If permissions are assigned to your role by document type, you can now edit the template outline for a document directly from that document. Docs have been updated to reflect this functionality.

How to test

Click on the live previews and compare the screencaps:

page OLD NEW
Manage document types Screenshot 2026-03-23 at 11 58 15 AM Screenshot 2026-03-23 at 12 01 11 PM
Customize document templates Screenshot 2026-03-23 at 11 58 47 AM Screenshot 2026-03-23 at 12 01 40 PMScreenshot 2026-03-23 at 12 01 32 PM
Manage document templates
old.mov
new.mov

What needs special review?

n/a

Dependencies, breaking changes, and deployment notes

Important

Permissions page update is covered by sc-5927; to avoid overlapping I left editing that page out of this PR.

Release notes

You're now able to edit template outlines directly from specific active model documents, streamlining your documentation processes.

Manage document templates

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 23, 2026
@validbeck validbeck added enhancement New feature or request internal Not to be externalized in the release notes labels Mar 23, 2026
@github-actions
Copy link
Copy Markdown
Contributor

PR Summary

This PR refines and extends the documentation for editing document templates and their outlines. The changes introduce a dual mode of editing, based on whether a custom metadata tag is present. Specifically:

  • New guidance has been added for editing template outlines either through the Settings panel or directly on model documents. These instructions are conditionally displayed using metadata flags (with and without the customize: true tag).

  • A new reusable include file (_outline-editing-mode.qmd) has been created to standardize the instructions during outline editing mode. This file describes how to expand, rename, remove, reorder sections, and add new sections and content blocks.

  • The documentation now clarifies the process involved in saving changes. In one mode, after making edits, users are instructed to create a new version via side-by-side comparisons, while in the alternate mode directly editing on documents requires users to click "Done Editing" to apply changes.

  • Minor content adjustments have been made in other related files (such as manage-document-templates.qmd and manage-document-types.qmd) to update references and improve consistency in the workflow instructions. Updated footnotes and internal links ensure that users are directed to the correct supplementary guides.

Test Suggestions

  • Manually verify that when the customize metadata tag is present or absent, the correct set of instructions appears on the page.
  • Check that the _outline-editing-mode include file renders correctly within both editing contexts (from Settings and on documents).
  • Validate that the updated footnotes and internal links point to the expected sections of the documentation.
  • Perform a review on different output formats (HTML, revealjs) to ensure conditional content is displayed appropriately.

@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: ea9e1b6

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.66 1.00 0.82
/get-started/get-started.html 0.85 0.71 1.00 0.73
/guide/guides.html 0.81 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.65 0.96 0.73

@github-actions
Copy link
Copy Markdown
Contributor

Validate docs site

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

Copy link
Copy Markdown
Member

@panchicore panchicore left a comment

Choose a reason for hiding this comment

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

🌮 🍦 beautiful!

@validbeck validbeck merged commit 0bc916d into main Mar 24, 2026
8 of 10 checks passed
@validbeck validbeck deleted the beck/sc-14815/documentation-document-outline-permissions branch March 24, 2026 21:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request internal Not to be externalized in the release notes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants