[Docs] Document Dock paths in Blueprint and API docs - #4083
Conversation
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Updates developer and Blueprint documentation to reflect the current Playground Dock entry points and the updated Sites/Query API behaviors around storage, autosaves, and persistence.
Changes:
- Refreshes Sites API docs to match the current public API shape (storage + optional persistence, autosave behavior, and newly documented methods/options).
- Updates Query API parameter descriptions (
overlay,storage=temp,can-save=no) to match current Dock behavior and lifecycle implications. - Documents Dock-first Blueprint entry points across Blueprint docs (gallery, URL, authoring, and current Blueprint pane).
Reviewed changes
Copilot reviewed 7 out of 23 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| packages/docs/site/docs/developers/intro-devs.md | Updates limitations summary wording to reflect current persistence/recovery constraints. |
| packages/docs/site/docs/developers/06-apis/sites-api/01-index.md | Major rewrite to align Sites API docs with current storage + persistence lifecycle and exposed methods. |
| packages/docs/site/docs/developers/06-apis/query-api/01-index.md | Updates storage, can-save, and overlay parameter wording to match current Dock behavior. |
| packages/docs/site/docs/developers/06-apis/01-index.md | Adjusts Sites API overview to reference Dock terminology. |
| packages/docs/site/docs/blueprints/tutorial/02-how-to-load-run-blueprints.md | Adds Dock-based instructions as the primary/easiest Blueprint entry point. |
| packages/docs/site/docs/blueprints/06-bundles.md | Mentions Dock UI path for Blueprint bundles in addition to blueprint-url. |
| packages/docs/site/docs/blueprints/02-using-blueprints.md | Expands “Using Blueprints” list with Dock entry points and adds a Dock screenshot. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
Marking this as a draft. It needs review and likely rewriting before it is ready. |
|
Some images are included, but I'm not seeing them added in the markdown |
67edcee to
0e228d4
Compare
|
Thank you @fellyph! I've fixed that and reviewed all the writing and I think it's good to go. I'll go ahead and merge. |
The developer docs now describe the current Dock entry points and the current stored-site lifecycle. The old API pages still talk about a site manager and temporary-by-default visits, and the Blueprint docs make URL fragments look like the primary website flow even though the Dock has first-class Blueprint paths.
This documents New → Blueprint gallery, New → Blueprint URL, New → Write a Blueprint, and the current Blueprint pane. It also updates the Query API wording for
overlay,storage=temp, andcan-save=no.The Sites API page now matches the public API shape:
list()returnsstorageand optionalpersistence, fresh visits normally autosave when saving is available, temporary Playgrounds are explicit, and the currently exposedautosaveTemporarySite,keep,createNewSavedSite, andupdateRuntimeSettingsmethods are documented.Markdown previews:
Verification:
npm run format:uncommitted npm exec nx -- run docs-site:check-orphan-pages git diff --checknpm run build:docscurrently stops in this workspace before compiling the changed pages because the localsharpnative module is missingsharp-darwin-arm64v8.node, even afternvm useandnpm rebuild sharp.