Skip to content

[SC-18631] Present the PDF size limit as guidance across the PDF guides - #1542

Merged
emmavdh merged 3 commits into
mainfrom
emma/sc-18631/document-checker-pdf-limit
Oct 2, 2026
Merged

emmavdh merged 3 commits into
mainfrom
emma/sc-18631/document-checker-pdf-limit

Conversation

@emmavdh

@emmavdh emmavdh commented Oct 2, 2026 •

Copy link
Copy Markdown
Collaborator

What and why?

Part of the Docs 26.10 tracker (sc-18631). The 250 MB figure in the docs is the backend's default pdf-parse cap (utils/pdf_parse_limits.py), which self-hosted deployments can override, and in practice processing time depends more on page count and figures than on file size. Per Juan Martinez, present it as guidance rather than a hard limit, consistently everywhere PDFs are read.

Changes:

  • guide/documentation/_check-documents.qmd: the Document Checker guide had no size guidance at all. The "first check reads the file" callout gains a bullet: keep PDFs under 250 MB as a guideline, a few hundred pages are supported, reading time grows with page count and figures, and a deployment may enforce a different limit.
  • guide/templates/_create-document-templates.qmd (template outline from PDF) and guide/templates/manage-documents.qmd (PDF to document conversion): "Maximum size: 250 MB" becomes "Recommended size: under 250 MB", plus the deployment note.

The matching 26.10 release note is adjusted in validmind/release-notes#169.

How to test

Preview (the preview site builds when the PR leaves draft; allow time for the deploy):

What needs special review?

  • Wording agreed with Juan on October 2. Juan's Document Checker stress tests may later add practical page-count guidance.

Dependencies, breaking changes, and deployment notes

Release notes

None (wording of an existing limit).

Checklist

  • What and why
  • How to test
  • What needs special review
  • Dependencies, breaking changes, and deployment notes
  • Labels applied
  • PR linked to Shortcut

🤖 Generated with Claude Code

@emmavdh emmavdh added the documentation Improvements or additions to documentation label Oct 2, 2026
The 250 MB limit is enforced by the shared pdf-parse limits for every PDF
workflow, including the Document Checker reading step, but the checker guide
never said so. Adds one line to the reading callout, linking to the
documented PDF requirements.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@emmavdh
emmavdh force-pushed the emma/sc-18631/document-checker-pdf-limit branch from 1e72803 to 2b7ba8c Compare October 2, 2026 17:27
@emmavdh emmavdh self-assigned this Oct 2, 2026
@emmavdh
emmavdh marked this pull request as ready for review October 2, 2026 17:28
@emmavdh
emmavdh requested review from cachafla and juanmleng October 2, 2026 17:28
@emmavdh emmavdh changed the title [SC-18631] State the PDF size limit for Document Checker reads [SC-18631] Present the PDF size limit as guidance across the PDF guides Oct 2, 2026
Per Juan: the figure is the backend default and deployments can set their
own, so the Document Checker, document conversion and template outline
pages now call it a recommended size and note that a deployment may enforce
a different limit.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@emmavdh
emmavdh enabled auto-merge October 2, 2026 18:04
@github-actions

github-actions Bot commented Oct 2, 2026

Copy link
Copy Markdown
Contributor

Validate docs site

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

@github-actions

github-actions Bot commented Oct 2, 2026

Copy link
Copy Markdown
Contributor

Lighthouse check results

✓ INFO: Average accessibility score is 0.93 (required: ≥0.9) — View the workflow run

Audit mode: changed pages (1 URL(s))

Show Lighthouse scores

Commit SHA: ff494cc

For a thorough audit, run the Lighthouse check workflow manually (Actions → Lighthouse check → Run workflow) with depth 0–2, or add the lighthouse:full label for depth 2 on the next validate run.

Page Accessibility Performance Best Practices SEO
/guide/templates/manage-documents.html 0.93 0.69 1.00 0.73
/guide/templates/manage-documents.html 0.93 0.71 1.00 0.73
/guide/templates/manage-documents.html 0.93 0.71 1.00 0.73

@emmavdh
emmavdh added this pull request to the merge queue Oct 2, 2026
Merged via the queue into main with commit 52e64a5 Oct 2, 2026
5 checks passed
@emmavdh
emmavdh deleted the emma/sc-18631/document-checker-pdf-limit branch October 2, 2026 18:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants