Skip to content

[SC-17216] Document cancelling PDF template outline generation from My Inbox - #1485

Merged
emmavdh merged 1 commit into
mainfrom
emma/sc-17216/cancel-pdf-template-outline-generation
Aug 28, 2026
Merged

[SC-17216] Document cancelling PDF template outline generation from My Inbox#1485
emmavdh merged 1 commit into
mainfrom
emma/sc-17216/cancel-pdf-template-outline-generation

Conversation

@emmavdh

@emmavdh emmavdh commented Aug 27, 2026

Copy link
Copy Markdown
Collaborator

Pull Request Description

What and why?

Documents sc-17216 — cancelling and recovering from stalled PDF template uploads (tracker: sc-17996 / Docs 26.09). Shipped in validmind/backend#3415 and validmind/frontend#2767, both merged and live.

This resolves the open question from the earlier attempt (documentation#1469, closed): the feature's home now exists in the docs. The Start Outline From PDF flow in _create-document-templates.qmd already tells users to track progress in My Inbox — which is exactly where the new cancel action lives — so this is an incremental edit to that flow rather than a new page.

Summary of changes

One include edited, both format variants:

  • New step after "Track progress in My Inbox": cancel outline generation that is still in progress — including an upload that appears stuck — via Cancel on the job in My Inbox.
  • New callout on the recovery semantics, verified against the implementation:
    • Cancelling removes the uploaded PDF and leaves the template outline unchanged (backend cleans up the staged file; a cancelled job never auto-applies an outline).
    • Cancellation works even when the upload hasn't started processing — the cancel marker is durable, so a job stuck waiting for workers is dropped as soon as it is picked up (the core fix in backend#3415).
    • Cancelled jobs show as cancelled rather than failed in My Inbox (cancelled is a distinct terminal state).
  • The condensed revealjs variant of the include gets a matching one-line mention.

How to test

You can just read it here - added D in below screenshot + callout box
image

Try the live preview (allow time for the PR preview deploy to finish):

The only consumer of the edited include is manage-document-templates.qmd; it renders clean locally with quarto render --profile development (only the pre-existing validmind/validmind.qmd warning), and the new step and callout were verified in the rendered HTML.

What needs special review?

  • UI labels verified against the merged frontend source (TemplatePdfParseInboxItem): the button is Cancel (no confirmation step; shows "Cancelling" while in flight), and the terminal states read "Outline generation cancelled" vs "PDF parse failed".
  • Deliberately scoped to the My Inbox path. Follow-up sc-17763 adds a second cancel affordance on the template detail page, but it is unstarted (Sprint 109 / 26.10 epic) — documenting it now would describe UI that doesn't exist. It can be its own incremental edit when it ships.

Dependencies, breaking changes, and deployment notes

  • Implements docs for: validmind/backend#3415 (merged), validmind/frontend#2767 (merged). No feature flag — the capability is live.
  • No dependency on any other docs PR.

Release notes

You can now cancel a PDF template outline generation that is still in progress — including an upload that appears stuck — from My Inbox. Cancelling removes the uploaded PDF and leaves the template outline unchanged, so it's safe to try again. Learn more ...

Checklist

  • What and why
  • Screenshots or videos (Frontend) — n/a
  • How to test
  • What needs special review
  • Dependencies, breaking changes, and deployment notes
  • Labels applied
  • PR linked to Shortcut
  • Unit tests added (Backend) — n/a
  • Tested locally
  • Documentation updated (if required)
  • Environment variable additions/changes documented (if required) — n/a

@emmavdh emmavdh added the documentation Improvements or additions to documentation label Aug 27, 2026
@emmavdh emmavdh self-assigned this Aug 27, 2026
…y Inbox

Adds a cancel step and recovery callout to the Start Outline From PDF
flow: cancel from My Inbox works even for stuck uploads, removes the
uploaded PDF, leaves the template outline unchanged, and shows as
cancelled rather than failed.

Co-Authored-By: Claude Fable 5 <[email protected]>
@emmavdh
emmavdh force-pushed the emma/sc-17216/cancel-pdf-template-outline-generation branch from 9067410 to e447201 Compare August 28, 2026 03:46
@github-actions

Copy link
Copy Markdown
Contributor

Validate docs site

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

@panchicore panchicore left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM

@emmavdh
emmavdh added this pull request to the merge queue Aug 28, 2026
Merged via the queue into main with commit 27db527 Aug 28, 2026
4 of 5 checks passed
@emmavdh
emmavdh deleted the emma/sc-17216/cancel-pdf-template-outline-generation branch August 28, 2026 13:15
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.

3 participants