Skip to content

Update docs blueprint supporting encodeURIComponent URL fragments - #3556

Merged
adamziel merged 8 commits into
trunkfrom
update-docs-blueprint-url
Apr 28, 2026
Merged

Update docs blueprint supporting encodeURIComponent URL fragments#3556
adamziel merged 8 commits into
trunkfrom
update-docs-blueprint-url

Conversation

@fellyph

@fellyph fellyph commented Apr 28, 2026

Copy link
Copy Markdown
Collaborator

Motivation for the change, related issues

Website now supports the encodeURIComponent feature 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:

  • packages/docs/site/docs/blueprints/02-using-blueprints.md
  • packages/docs/site/docs/blueprints/09-troubleshoot-and-debug-blueprints.md
  • packages/docs/site/docs/blueprints/09-troubleshoot-and-debug-blueprints.md

Testing Instructions (or ideally a Blueprint)

  1. Pull the branch update-docs-blueprint-url
  2. Install the packages
  3. Run the command npm run dev:docs
  4. Review the content on the pages
@fellyph
fellyph requested review from a team, brandonpayton and Copilot April 28, 2026 19:38
@github-actions github-actions Bot added the [Type] Documentation Improvements or additions to documentation label Apr 28, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread packages/docs/site/docs/blueprints/09-troubleshoot-and-debug-blueprints.md Outdated
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

Copilot AI Apr 28, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copilot uses AI. Check for mistakes.
@adamziel
adamziel merged commit b71e3dc into trunk Apr 28, 2026
48 checks passed
@adamziel
adamziel deleted the update-docs-blueprint-url branch April 28, 2026 23:17
@adamziel

Copy link
Copy Markdown
Collaborator

Thank you @fellyph !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

[Type] Documentation Improvements or additions to documentation

3 participants