fix: correct documentation inaccuracies in API and troubleshooting guides#100
Draft
Copilot wants to merge 2 commits intoimprove-docs-11858702151210839129from
Draft
fix: correct documentation inaccuracies in API and troubleshooting guides#100Copilot wants to merge 2 commits intoimprove-docs-11858702151210839129from
Copilot wants to merge 2 commits intoimprove-docs-11858702151210839129from
Conversation
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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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_videotool with actualexport_projecttool name; removed reference to fictional "Tool execution timed out" error message; clarified timeout guidance to focus on system resources and deployment configurationdocs/api.md: Added missing required
effects: []field to Project JSON clip example to matchClipinterface in@ai-video-editor/shared-typesdocs/api.md: Changed code fences from
jsontojsoncfor examples containing inline comments to prevent invalid JSON that breaks copy/pastedocs/api.md: Documented optional
modelandprojectDatafields incopilot.messageWebSocket 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.