Skip to content

Conversation

@validbeck
Copy link
Collaborator

@validbeck validbeck commented Dec 16, 2025

Pull Request Description

What and why?

sc-12651

You can now export default document types as PDF. Docs updated to reflect this.

How to test

Click on the live preview: Export documents

What needs special review?

n/a

Dependencies, breaking changes, and deployment notes

n/a

Release notes

Should be covered by https://github.com/validmind/frontend/pull/1590.

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 Dec 16, 2025
@validbeck validbeck added DO NOT MERGE PR is not ready to be merged internal Not to be externalized in the release notes labels Dec 16, 2025
@github-actions
Copy link
Contributor

PR Summary

This pull request updates the documentation for exporting model documents by clarifying and expanding export options. The changes include:

  • Updated descriptions to indicate that exported documents can now be generated not only as Microsoft Word files (DOCX) but also as PDFs. The instructions now specify that DOCX exports prompt for updating the table of contents and that PDF exports preserve formatting and auto-generate links and the table of contents.
  • The callout for Microsoft Word compatibility has been enhanced with a title that improves clarity regarding supported versions of Word (365, 2019, 2016, and 2013).
  • Step-by-step instructions have been refined with bullet point adjustments, ensuring clear guidance on checking export options (such as exporting comments) and selecting file formats.
  • Footnotes and in-text references have been updated to reflect the changes in the export process and to point to the correct documentation pages.

Overall, the changes improve the usability of the export functionality in the user interface and help users understand the additional PDF export option alongside DOCX.

Test Suggestions

  • Verify that exporting a document in DOCX format prompts the user to update the table of contents as described.
  • Test that exporting a document in PDF format preserves formatting, generates an accurate table of contents, and includes correct links.
  • Confirm that the callout box displays the new title and correctly lists the supported Microsoft Word versions.
  • Ensure that the updated footnotes reference the correct documentation pages and that links function as expected.

@github-actions
Copy link
Contributor

Validate docs site

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

@github-actions
Copy link
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: f1f914d

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.61 1.00 0.90
/get-started/get-started.html 0.85 0.70 1.00 0.80
/guide/guides.html 0.85 0.69 1.00 0.90
/index.html 0.93 0.66 1.00 0.90
/releases/all-releases.html 0.86 0.68 1.00 0.80
/support/support.html 0.91 0.66 1.00 0.90
/training/training.html 0.85 0.63 0.96 0.80

@validbeck validbeck changed the title [TESTING] html widgets in notebooks docs: Export documents in PDF Dec 16, 2025
@validbeck validbeck removed the DO NOT MERGE PR is not ready to be merged label Dec 16, 2025
Copy link
Contributor

@johnwalz97 johnwalz97 left a comment

Choose a reason for hiding this comment

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

looks good to me

@validbeck validbeck merged commit f941394 into main Dec 17, 2025
19 checks passed
@validbeck validbeck deleted the beck/sc-12651/documentation-export-documentation-as-pdf branch December 17, 2025 17:08
nrichers added a commit that referenced this pull request Dec 23, 2025
* docs: Show model stakeholder updates in model activity (#1078)

* Edit: View model activity

* Edit

* docs: Ability to cancel pending user invitations (#1080)

* Edit: Manage users

* Edit training

* docs: Export documents in PDF (#1081)

* Edit: Export documents

* Footnotes & cleanup

* Edit: Configure workflows (#1086)

* Remove support number (#1085)

* Nrichers/sc 13410/documentation use custom fields in model (#1074)

* Move callout for lazy readers, minor edit

* Initial topic updates

* Move shared file to match our de facto convention, fix typo, add margin links

* Break filter content out into its own topic

* Experiment with buttons

* Edits, edits, edits

* Add more imbed examples for the review

* Lots more edits

* Edits

* Edits

* Text edits

* Minor text tweaks

* Formatting tweaks

* Add .callout-button styles

* Fix active/inactive tabset text colors

* Split steps in examples

* Attempt a fix at transparency issue in callouts

* Formatting tweaks

* Remove YAML header

* Address review feedback

* Add wrapper topic for help links from the UI

* Move select your filters files into shared/ folder

* Style + instruction edits

* Undo file rename & move images

---------

Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com>

* file rename: Select your filters > Work with filters (#1093)

* Select your filters > Work with filters

* Replace

* Preview for 26.01 release notes & make get-source (#1091)

* Preview for 26.01 release notes

* Update .github/workflows/validate-docs-site.yaml

* Documentation - Attestations enhancements (#1090)

* Initial set of docs changes for improved attestation process

* Updated task topics and edits

* Minor edits

* Improve owner + group explanations

* Remove column experiment

* Edits

* Update prerequisites

* Add animated GIF

* Embed animated GIF in overview topic & tweak mermaid diagram

* Add collapsible section, hint about group filtering

* What could docs & training for AI governance look like? (#1087)

* Initial content generation experiment

* Content hacking

* More edits

* Edits

* Edits

* Minor edits

* Put use cases under umbrella categories

* Consistency edits, content improvements

* Update home page & edits

* Fix børked links

* Simplify title

* Change links to margin footnotes, other formatting fixes

* Massaging text for .tour-bg

* AI governance local edits

* EU AI Act edits

* Model risk management edits

* Library and platform edits

* Use case compliance include

* SR 11-7 edit

* SS1/23 edit

* E-23 edit

* Training: Consistency & subtitle card edits

* Training: Minor styling edit

* Update site/about/use-cases/model-risk-management.qmd

Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com>

* Rename topic to match short title

* Remove latinisms

* Update site/about/overview.qmd

Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com>

* Update site/about/use-cases/ai-governance.qmd

Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com>

* Update site/about/use-cases/ai-governance.qmd

Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com>

* Address review comments

* Minor addition to E-23 guide

---------

Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com>

---------

Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
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.

3 participants