feat: add Application Runtime docs and Sandbox snapshots/fork page#624
feat: add Application Runtime docs and Sandbox snapshots/fork page#624devin-ai-integration[bot] wants to merge 6 commits into
Conversation
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
🧪 Testing GuideWhat this PR addressesAdds new documentation pages for the Application Runtime feature (ENG-2908) and Sandbox Snapshots & Fork capabilities. This includes:
Steps to verify
What to verify (expected behavior)
Note Posted by PR Testing Guide · Tag @mendral-app with feedback. |
|
✅ Linked to Linear issue ENG-2908 — status already In Progress
Note Posted by Linear Issue Enforcer · Tag @mendral-app with feedback. |
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
📄 Documentation PR — Interaction FlowThis PR is documentation-only (new sequenceDiagram
participant User as User/Developer
participant SDK as SDK / CLI / HTTP API
participant App as Applications Service
participant Rev as Revision Manager
participant Sandbox as Sandbox Service
participant Snap as Snapshot Store
Note over User, App: Applications Lifecycle (Overview.mdx)
User->>SDK: Create Application (name, env vars, compute)
SDK->>App: Deploy application
App->>Rev: Create initial revision
Rev-->>App: Revision active (status: serving)
App-->>User: Public endpoint URL
User->>SDK: Update Application (new config)
SDK->>App: Deploy new revision
App->>Rev: Traffic split (canary %)
Rev-->>App: Gradual rollout
App-->>User: Sticky session / custom URL
Note over User, Snap: Snapshots & Fork (Snapshots-and-fork.mdx)
User->>SDK: Create Snapshot (sandbox_id)
SDK->>Sandbox: Capture state
Sandbox->>Snap: Store snapshot
Snap-->>User: Snapshot ID
User->>SDK: Fork Sandbox or Application
SDK->>Snap: Load snapshot (optional)
Snap->>Sandbox: Restore state → new sandbox
Snap->>App: Restore state → new application
App-->>User: Forked resource with traffic control
Summary
No code changes to review — only documentation content and structure. Note Posted by PR Sequence Diagram · Tag @mendral-app with feedback. |
… mention Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
…rk and Schedules entries Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Summary
Adds customer-facing documentation for the new Application Runtime feature (ENG-2908) and sandbox snapshot/fork capabilities.
New pages:
Applications/Overview.mdx— single comprehensive page covering:0/1-99/100, sticky sessions)Sandboxes/Snapshots-and-fork.mdx— snapshot and fork operations:bl fork sbx/... app/...), and HTTP APINavigation (
docs.json):Link to Devin session: https://app.devin.ai/sessions/2d9e244c4263469c8020ddff54347def
Requested by: @drappier-charles
Note
New commit adds a
prefixfork parameter to the Sandboxes doc and a dedicated custom domain creation endpoint example for applications.Written by Mendral for commit 0f7d99a.