Skip to content

Update background assembly instructions for saved completion gates - #635

Open
nonprofittechy wants to merge 1 commit into
mainfrom
docs/background-assembly-completion-gates
Open

nonprofittechy wants to merge 1 commit into
mainfrom
docs/background-assembly-completion-gates

Conversation

@nonprofittechy

Copy link
Copy Markdown
Member

Returning to a completed interview after Celery expires its task result can leave users stuck on a waiting screen when interview order checks .ready() directly. This updates the background assembly guide to use saved completion variables and explains how to regenerate documents after edits.

The instructions assume AssemblyLine PR #1113 is merged and available. Merge this documentation alongside or after that implementation.

  • Make downloads_ready, downloads_with_docx_ready, and preview_ready the standard interview-order pattern.
  • Provide concrete download, preview, migration, regeneration, and customization examples.
  • Explain expiration, leaving during generation, shared download caches, and troubleshooting.
  • Correct the related advice in “Combining interviews” to start background assembly before displaying cached downloads.

Validation: both changed pages compiled with the site's Docusaurus MDX processor; all seven YAML/Python examples passed syntax checks; git diff --check passed. The underlying workflow was verified on localhost with two-second task-result expiration in AssemblyLine PR #1113.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant