Update docs blueprint supporting encodeURIComponent URL fragments - #3556
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 the Blueprints documentation to reflect the newly supported encodeURIComponent-encoded URL fragment format, and improves troubleshooting guidance for invalid Blueprint links.
Changes:
- Document
encodeURIComponent(JSON.stringify(blueprint))as the recommended way to build#fragment links from JavaScript/automation. - Add troubleshooting guidance for “Invalid blueprint” errors caused by double-encoding.
- Refresh docs formatting by switching a callout to Docusaurus admonition syntax and updating an image reference.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| packages/docs/site/docs/blueprints/tutorial/02-how-to-load-run-blueprints.md | Replaces “Base64 encoded Blueprints” section with guidance for encoded URL fragments and keeps Base64 as an alternative. |
| packages/docs/site/docs/blueprints/09-troubleshoot-and-debug-blueprints.md | Adds a new troubleshooting section for invalid/double-encoded fragments and updates callout + image reference. |
| packages/docs/site/docs/blueprints/02-using-blueprints.md | Adds example code for URL-encoding fragment JSON and expands the docs section to include encoded fragments + Base64 guidance. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| Use this method to run the example code in the next chapter, [**Build your first Blueprint**](/blueprints/tutorial/build-your-first-blueprint). | ||
|
|
||
| ### Base64 encoded Blueprints | ||
| ### Encoded Blueprint fragments |
There was a problem hiding this comment.
The PR description’s “Updated the following pages” list appears to be inaccurate (it repeats 09-troubleshoot-and-debug-blueprints.md and doesn’t mention tutorial/02-how-to-load-run-blueprints.md, which is changed here). Please update the PR description so the touched docs are correctly listed.
|
Thank you @fellyph ! |
Motivation for the change, related issues
Website now supports the
encodeURIComponentfeature included on PR #3527. This pull request includes examples and updates the tutorials with related content.Implementation details
Updated the following pages in English, Spanish, Portuguese and French:
Testing Instructions (or ideally a Blueprint)
update-docs-blueprint-urlnpm run dev:docs