Skip to content

docs: Reference other sections in document content blocks#1332

Merged
validbeck merged 4 commits into
mainfrom
beck/sc-15297/documentation-references-in-documentation
May 19, 2026
Merged

docs: Reference other sections in document content blocks#1332
validbeck merged 4 commits into
mainfrom
beck/sc-15297/documentation-references-in-documentation

Conversation

@validbeck

@validbeck validbeck commented May 16, 2026

Copy link
Copy Markdown
Collaborator

Pull Request Description

What and why?

sc-15297

We now have functionality for:

Screenshot 2026-05-15 at 8 21 27 PM

How to test

Click on the live preview for the net-new section: Work with content blocks

What needs special review?

n/a

Dependencies, breaking changes, and deployment notes

n/a

Release notes

Covered by https://github.com/validmind/frontend/pull/2419 & https://github.com/validmind/frontend/pull/2418 & https://github.com/validmind/backend/pull/2964.

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)

@github-actions

Copy link
Copy Markdown
Contributor

Pull requests must include at least one of the required labels: internal (no release notes required), highlight, enhancement, bug, deprecation, documentation. Except for internal, pull requests must also include a description in the release notes section.

@validbeck validbeck added the internal Not to be externalized in the release notes label May 16, 2026
@validbeck validbeck self-assigned this May 16, 2026
@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: beed064

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.70 1.00 0.73
/guide/guides.html 0.85 0.69 1.00 0.82
/index.html 0.93 0.68 1.00 0.82
/releases/all-releases.html 0.86 0.69 1.00 0.73
/support/support.html 0.91 0.66 1.00 0.82
/training/training.html 0.85 0.64 0.96 0.73

@validbeck validbeck requested a review from johnwalz97 May 16, 2026 03:48

@johnwalz97 johnwalz97 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

lgtm besides just adding the second way of adding reference links

Comment thread site/guide/documentation/work-with-content-blocks.qmd
@github-actions

Copy link
Copy Markdown
Contributor

PR Summary

This PR introduces updates to the documentation for content blocks. In the first file, the instructions for using the AI content generation feature have been refined. Instead of directing the user to click on a specific icon in the toolbar, the instructions now explicitly state to click on the ellipsis-vertical icon and then select the AI generation option.

The second file has been significantly updated by adding a new section titled "Reference document sections." This section provides clear guidance on how to create hyperlinks to other parts of a document directly within a text block. Two methods are described:

  • From the content block editor by typing # and selecting the desired section from the table of contents.
  • Using the content toolbar by clicking the ellipsis-vertical icon, selecting the link insertion option, and then choosing the section to reference.

In addition, adjustments have been made to the footnotes to correctly reference and order links related to document exports, model inventory, document versions, and documents. These changes aim to improve the clarity and usability of the documentation for users working with content blocks.

Test Suggestions

  • Verify that the content block editor displays the ellipsis-vertical icon with the correct context menu options.
  • Test the AI content generation workflow to ensure that the updated instructions match the actual behavior of the toolbar.
  • Validate that hyperlinks in the Reference document sections correctly navigate to the intended sections in both on-screen and PDF exports.
  • Check that the footnote links are correctly updated and lead to the expected documentation pages.

@github-actions

Copy link
Copy Markdown
Contributor

Validate docs site

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

@validbeck validbeck merged commit 3e804cd into main May 19, 2026
8 of 9 checks passed
@validbeck validbeck deleted the beck/sc-15297/documentation-references-in-documentation branch May 19, 2026 16:56
@validbeck validbeck mentioned this pull request May 26, 2026
11 tasks
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