Skip to content

Document tables and figures appendix export option#1278

Merged
nrichers merged 1 commit intomainfrom
nrichers/sc-15721/docs-export-appendix-toggle-frontend-pr-2419
Apr 10, 2026
Merged

Document tables and figures appendix export option#1278
nrichers merged 1 commit intomainfrom
nrichers/sc-15721/docs-export-appendix-toggle-frontend-pr-2419

Conversation

@nrichers
Copy link
Copy Markdown
Collaborator

@nrichers nrichers commented Apr 10, 2026 •
edited
Loading

Pull Request Description

Summary of changes

  • Document the Include tables and figures appendix option in the export flow for model documentation (development) exports on the Export documents page.
  • Explain that the appendix depends on the organization setting for numbered table and figure captions, and that the checkbox stays visible but cannot be selected when that setting is off.
  • For readability, reorder .smallercaps label to follow each bullet.
  • Renumber footnotes for DOCX/PDF format lines after inserting the new appendix footnote.

What and why?

User-facing exports gained an optional tables and figures appendix (see frontend PR #2419); the guide previously did not mention it. This update aligns the reporting guide with the export modal and links readers to organization document defaults for the captions prerequisite.

Shortcut: sc-15721

How to test

Review the screenshot

Capto_ 2026-04-10_12-21-24_pm2

What needs special review?

  • Wording in footnote [^13] (“development reports only” label vs “model documentation”) — confirm it matches product language elsewhere.

Dependencies, breaking changes, and deployment notes

Release notes

When your organization uses numbered table and figure captions for documents, you can include a tables and figures appendix in Word or PDF exports of model documentation. Learn more about exporting documents.

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

github-actions bot commented Apr 10, 2026

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

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 10, 2026

PR Summary

This PR refines the instructions for exporting documents by updating the wording and order of checkbox options and their descriptions. The changes include:

  • Reordering the labels for the export options to clearly display when each option applies (e.g., "[validation reports only]" or "[development reports only]").
  • Introducing a new option to include a "tables and figures appendix" with an accompanying note on its dependency on organization settings for numbered captions.
  • Updating the footnotes to reflect the correct numbering and to provide clearer instructions for DOCX and PDF exports.
  • Minor adjustments in footnote content to clarify the behavior when the organization setting for numbered table and figure captions is off.

Overall, the PR focuses on improving the clarity of user instructions regarding document export configurations without modifying core functionality.

Test Suggestions

  • Test that all checkbox options render correctly and display the correct label order with associated conditions (e.g., when to show validation versus development report options).
  • Verify that the new 'tables and figures appendix' option appears only when the organizational setting allows for numbered captions.
  • Ensure that the updated footnotes (particularly [^13], [^14], and [^15]) link to the correct instructions and that the text is displayed as expected in the final document.
  • Confirm that DOCX and PDF export formats behave as described, specifically that DOCX prompts for table of contents updates and PDF retains formatting and clickable links.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 10, 2026

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.

@nrichers nrichers added the internal Not to be externalized in the release notes label Apr 10, 2026
@nrichers nrichers requested a review from cachafla April 10, 2026 19:29
@nrichers nrichers changed the title Document tables and figures appendix export option (sc-15721) Document tables and figures appendix export option Apr 10, 2026
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 10, 2026

Validate docs site

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

cachafla
cachafla approved these changes Apr 10, 2026
View reviewed changes
Copy link
Copy Markdown
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.

Great 👍

@nrichers nrichers merged commit c6e6be4 into main Apr 10, 2026
9 of 12 checks passed
@nrichers nrichers deleted the nrichers/sc-15721/docs-export-appendix-toggle-frontend-pr-2419 branch April 10, 2026 21:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@cachafla cachafla cachafla approved these changes

Assignees

No one assigned

Labels

internal Not to be externalized in the release notes

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@nrichers @cachafla