docs: Add REST API docs for version control endpoints#898
Merged
willeastcott merged 4 commits intomainfrom Feb 15, 2026
Merged
Conversation
Add documentation for branch and checkpoint version control endpoints: create branch, list checkpoints, get checkpoint, and create checkpoint. Includes Japanese translations and sidebar updates. Co-authored-by: Cursor <cursoragent@cursor.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds REST API documentation for four version control endpoints that enable programmatic management of branches and checkpoints in PlayCanvas projects. The documentation includes both English originals and Japanese translations, following the established documentation patterns.
Changes:
- Add documentation for branch creation (POST /branches) and checkpoint management (GET/POST /checkpoints, GET /branches/:id/checkpoints)
- Include Japanese translations for all new API documentation pages
- Update sidebar navigation to include new entries in alphabetical order
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| sidebars.js | Adds 4 new API documentation entries in alphabetical order within the REST API section |
| docs/user-manual/api/branch-create.md | Documents POST endpoint for creating new branches from existing branches/checkpoints |
| docs/user-manual/api/checkpoint-create.md | Documents POST endpoint for creating checkpoints that capture branch state |
| docs/user-manual/api/checkpoint-get.md | Documents GET endpoint for retrieving a checkpoint by ID |
| docs/user-manual/api/checkpoint-list.md | Documents GET endpoint for listing checkpoints for a branch with pagination |
| i18n/ja/docusaurus-plugin-content-docs/current/user-manual/api/branch-create.md | Japanese translation of branch creation documentation |
| i18n/ja/docusaurus-plugin-content-docs/current/user-manual/api/checkpoint-create.md | Japanese translation of checkpoint creation documentation |
| i18n/ja/docusaurus-plugin-content-docs/current/user-manual/api/checkpoint-get.md | Japanese translation of checkpoint retrieval documentation |
| i18n/ja/docusaurus-plugin-content-docs/current/user-manual/api/checkpoint-list.md | Japanese translation of checkpoint listing documentation |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
i18n/ja/docusaurus-plugin-content-docs/current/user-manual/api/checkpoint-list.md
Outdated
Show resolved
Hide resolved
i18n/ja/docusaurus-plugin-content-docs/current/user-manual/api/checkpoint-create.md
Outdated
Show resolved
Hide resolved
i18n/ja/docusaurus-plugin-content-docs/current/user-manual/api/branch-create.md
Outdated
Show resolved
Hide resolved
…/branch-create.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…/checkpoint-list.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…/checkpoint-create.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
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.
Fixes playcanvas/editor#162
Partially addresses playcanvas/editor#498
Summary
Test plan
npm run startnpm run start -- --locale jaMade with Cursor