Skip to content

Docs: Vibe message queue help article (VIBE-113)#781

Draft
haleyserrano wants to merge 1 commit into
masterfrom
claude/epic-noether-vul9rd
Draft

Docs: Vibe message queue help article (VIBE-113)#781
haleyserrano wants to merge 1 commit into
masterfrom
claude/epic-noether-vul9rd

Conversation

@haleyserrano

Copy link
Copy Markdown
Contributor

JIRA

VIBE-113 — Composer message queue: queue follow-up prompts while Vibe is generating

Classification

  • Type: UI/UX change (feature behavior change to the Vibe composer)
  • Repo targeted: Business App only. Vibe is documented under docusaurus/docs/business-app/ai/vibe/ and this change has no partner/reseller/agency-facing surface, so Partner Center docs are unaffected.

Summary of documentation updates

  • New: docusaurus/docs/business-app/ai/vibe/guides/message-queue.md — full guide covering: what the queue is, why it matters, queue panel/auto-fire/edit/remove/pause/resume/cap-of-3, step-by-step usage, interaction with Stop, clarifying questions, and generation failure, plus a 10-question FAQ.
  • Updated: docusaurus/docs/business-app/ai/vibe/getting-started.md — Step 4 previously said you could type your next message during a generation "and it won't interrupt the current run" with no mention of a queue. Replaced with the actual current behavior (messages queue and auto-fire) and linked to the new guide. Also updated the Stop row in the Chat Input reference table (Stop now also pauses the queue) and added the new guide to Next Steps.
  • Updated: docusaurus/docs/business-app/ai/vibe/guides/troubleshooting.md — added a short section noting that a failed generation auto-pauses the queue, with a link to the new guide, plus a Next Steps entry.

No duplication: the queue behavior is documented once in the new guide; the other two files only link to it and correct their own now-inaccurate one-line descriptions.

Existing docs vs. new docs

Both. getting-started.md and troubleshooting.md were updated in place (Step 4 rule: prioritize updating existing pages). A new page was added for the queue itself because it introduces a standalone, persistent UI surface (its own panel, cap, pause/resume, edit/remove) — parallel in scope to existing dedicated guides like Sessions and Ask Mode and Planning — rather than a one-line extension of an existing page.

Placement reasoning

Added under guides/ alongside the other Vibe composer/generation guides (plan-mode.md, troubleshooting.md, sessions-and-ask-mode.md), same level, same category (_category_.json unchanged). sidebar_position: 8 was chosen to avoid renumbering existing guides (current max was 7).

Acceptance criteria coverage

Mapped from the story's R1–R18 (user-visible items only; internal implementation details are intentionally omitted from end-user docs — see Assumptions):

AC Covered
R1 — queue instead of blocking ✅ "What is the Message Queue?"
R2 — payload parity (text/images/mode) ✅ "What is..." + "What's included"
R3 — cap of 3, full-queue message ✅ "What's included" (quotes the literal status text)
R4/R5 — persists, survives refresh ✅ "Why is... important?" (last-writer-wins omitted — internal detail)
R6/R7 — queue UI above composer, expand/collapse, count ✅ "What's included"
R8 — edit/remove ✅ "How to use"
R9 — auto-fire on natural completion ✅ "What's included" + "How to use"
R10/R11 — pause/resume; Stop cancels run + pauses queue ✅ "How to use" + "Additional details" + getting-started.md Stop row
R12 — no auto-fire while paused, can still edit ✅ "How to use" (Pause and resume)
R13/R14 — paused+idle sends direct, paused+generating still queues ✅ "Additional details" (Sending while paused)
R15/R16 — clarifying questions / plan approval hold the queue ✅ "Additional details" + troubleshooting.md cross-link
R17 — atomic dispatch Omitted — internal implementation detail, not user-visible
R18 — failure auto-pauses queue ✅ "Additional details" + troubleshooting.md

Figma / visual inputs

None were provided with this ticket. No screenshots were added to the new article (the standard article template calls for 2–3), since fabricating placeholder images would violate the source-based-only rule. This is a known limitation — screenshots should be added once the feature is available to capture from.

Skills used

  • generate-help-article (article structure/frontmatter/FAQ conventions)
  • pre-push-validation (frontmatter, tag balance, internal links)
  • Repo's scan-style.sh deterministic style scan (gray-label, evergreen, build-safety — all critical/build-safety checks passed; only pre-existing-style warnings like em dashes, consistent with sibling files in this section)

Assumptions and limitations

  • Epic not Done: Parent epic VIBE-92 ("Vibe production-readiness hardening") is still In Progress, but its two open siblings (VIBE-119: Terraform bucket import, VIBE-94: load testing/memory sizing) are infra-only tasks with no feature-flag/eligibility/region-gating signal for this specific feature. Proceeding per the rollout-verification rule's "no gating tickets found" path.
  • No linked GitHub PRs were found on VIBE-113, so a reviewer could not be auto-resolved from code authorship. Story assignee/reporter is Taylor Wiebe (twiebe@vendasta.com) — flagging for a human to add as reviewer if appropriate.
  • Internal-only ACs (dispatch atomicity, last-writer-wins conflict resolution) were intentionally left out of the end-user article since they aren't user-visible behavior.

@ahnikakuse @haleyserrano @maryam6samadi


Generated by Claude Code

Document the composer follow-up message queue: queuing while a
generation is in progress, edit/remove, pause/resume, the 3-message
cap, and how it interacts with Stop and generation failures. Updates
the outdated "just start typing" note in Getting Started and
cross-links from Troubleshooting.
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