Skip to content

Comments

fix: correct documentation inaccuracies in API and troubleshooting guides#100

Draft
Copilot wants to merge 2 commits intoimprove-docs-11858702151210839129from
copilot/sub-pr-99
Draft

fix: correct documentation inaccuracies in API and troubleshooting guides#100
Copilot wants to merge 2 commits intoimprove-docs-11858702151210839129from
copilot/sub-pr-99

Conversation

Copy link
Contributor

Copilot AI commented Feb 9, 2026

Addresses review feedback on PR #99 by fixing incorrect tool names, missing required fields, and invalid JSON syntax in documentation.

Changes:

  • docs/troubleshooting.md: Replaced non-existent render_video tool with actual export_project tool name; removed reference to fictional "Tool execution timed out" error message; clarified timeout guidance to focus on system resources and deployment configuration

  • docs/api.md: Added missing required effects: [] field to Project JSON clip example to match Clip interface in @ai-video-editor/shared-types

  • docs/api.md: Changed code fences from json to jsonc for examples containing inline comments to prevent invalid JSON that breaks copy/paste

  • docs/api.md: Documented optional model and projectData fields in copilot.message WebSocket payload (fields already supported by backend handler but previously undocumented)

Example:

{
  "type": "copilot.message",
  "payload": {
    "content": "Add a 5 second clip...",
    "projectId": "550e8400-e29b-41d4-a716-446655440000",
    "model": "gpt-4o-mini",      // optional: override model
    "projectData": { ... }        // optional: project snapshot for context
  }
}

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Co-authored-by: Godzilla675 <131464726+Godzilla675@users.noreply.github.com>
Copilot AI changed the title [WIP] Improve project documentation and add troubleshooting guide fix: correct documentation inaccuracies in API and troubleshooting guides Feb 9, 2026
Copilot AI requested a review from Godzilla675 February 9, 2026 07:42
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