Skip to content

Update background assembly instructions for saved completion gates - #635

Merged
nonprofittechy merged 2 commits into
mainfrom
docs/background-assembly-completion-gates
Oct 5, 2026
Merged

nonprofittechy merged 2 commits 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.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot review overview

🟡 Changes recommended

The documentation incorrectly presents four seconds as the minimum configurable reload interval.

Review effort: Balanced
Findings: 1 Low severity

Open (1)
What changed in this PR

Updates background assembly guidance to use durable completion gates introduced by AssemblyLine PR #1113.

Changes:

  • Documents completion variables, regeneration, customization, and troubleshooting.
  • Updates combined-interview guidance to start background assembly before downloads.
File Description
docs/​components/​AssemblyLine/​background_assembly.md Reworks background assembly documentation.
docs/​authoring/​combining_interviews.md Corrects combined-packet guidance.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread docs/components/AssemblyLine/background_assembly.md Outdated
Clarify how to set the reload interval for assembly.

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@nonprofittechy
nonprofittechy merged commit 5f3ed19 into main Oct 5, 2026
2 checks passed
@nonprofittechy
nonprofittechy deleted the docs/background-assembly-completion-gates branch October 5, 2026 16:36
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.

2 participants