Skip to content

[Docs] Document the diagnostics report command - #71

Draft
zoomote2[bot] wants to merge 1 commit into
mainfrom
feature/document-diagnostics-report-recreation
Draft

zoomote2[bot] wants to merge 1 commit into
mainfrom
feature/document-diagnostics-report-recreation

Conversation

@zoomote2

@zoomote2 zoomote2 Bot commented Nov 3, 2026

Copy link
Copy Markdown

​Created by Roomote. Follow up by mentioning @roomote, in the web UI, or in Discord.

Supersedes #22. This PR recreates that open draft on the current main so the documentation stands on its own now that the implementation is merged.

What changed

Documents zoo-code.createDiagnosticsReport in the Command Palette section of the Settings Management guide, including when to use it for a blank or white webview, missing history, and failed task or subtask navigation. The guidance explains that the generated JSON is redacted, opened locally, copied for sharing, and never uploaded automatically.

Why this change was made

Users need a clear support path when the Zoo Code webview cannot expose enough information to diagnose its own failure. The Zoo Code implementation (#2292) is merged, so the documented behavior is now shipped behavior.

Impact

The guide tells users what structural data the report includes, which sensitive data it excludes, and to review the report before sharing it.

Screenshots

The Settings Management guide documents the diagnostics command, supported failure cases, privacy exclusions, and no-upload behavior.

The screenshot is carried over unchanged from #22. The documented section text is identical, so the rendered result is the same. The section rendering was re-verified against the live docs build of this branch.

Related PRs

@zoomote2

zoomote2 Bot commented Nov 3, 2026 •

Copy link
Copy Markdown
Author

No code issues found. See session

Reviewed ccbf1cd

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