Skip to content

docs: Update Live Browser preview documentation to match implementation - #754

Merged
numnx merged 2 commits into
feature/CODUX-44-qs-documentation-developer-surface-audit-2from
fix-preview-docs-8704166769834444643
Jul 7, 2026
Merged

docs: Update Live Browser preview documentation to match implementation#754
numnx merged 2 commits into
feature/CODUX-44-qs-documentation-developer-surface-audit-2from
fix-preview-docs-8704166769834444643

Conversation

@numnx

@numnx numnx commented Jul 7, 2026

Copy link
Copy Markdown
Owner

This updates the sprint browser preview documentation across docs/ and docs-web/ to be aligned with the actual implementation and tooling APIs available in Code UX.

Changes:

  • Corrects docs/architecture/sprint-preview-browser.md API surface table to include both browser/sessions and projects/:projectId/sprints/:sprintId/preview/sessions/ endpoints.
  • Highlights that preview sessions are explicitly scoped per project/sprint pair.
  • Updates docs/dashboard/browser-preview.md to specify that rebuild, stop, and remove track distinct pending actions.
  • Clarifies port mapping support, stating that multiple container ports map to explicit loopback addresses and render as distinct tabs.
  • Corrects script workflow in docs-web/user/dashboard/browser-preview.md and replaces get_script with update_script where it implies saving behaviors.
  • Updates docs-web/user/troubleshooting.md to point users to the dashboard logs/MCP tools instead of using docker ps.
  • Syncs the MCP tooling capabilities in docs/mcp/tools-and-contracts.md to clarify the full set of preview actions.

PR created automatically by Jules for task 8704166769834444643 started by @numnx

…pabilities

Updates documentation files to correctly describe the per project/sprint scoped nature
of preview sessions, explicitly calling out multiple port mappings on localhost,
documenting the complete lifecycle (start, rebuild, stop, remove) including the
dashboard/MCP actions, and reflecting the `update_script` endpoint.

Fixes missing proxy port details and corrects the troubleshooting logs guidance
to prefer the dashboard controls/MCP instead of generic docker commands.

Co-authored-by: numnx <1517214+numnx@users.noreply.github.com>
@google-labs-jules

Copy link
Copy Markdown

👋 Jules, reporting for duty! I'm here to lend a hand with this pull request.

When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down.

I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job!

For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with @jules. You can find this option in the Pull Request section of your global Jules UI settings. You can always switch back!

New to Jules? Learn more at jules.google/docs.


For security, I will only act on instructions from the user who triggered this task.

…ce-audit-2 into fix-preview-docs-8704166769834444643
@numnx
numnx merged commit 67935d5 into feature/CODUX-44-qs-documentation-developer-surface-audit-2 Jul 7, 2026
6 checks passed
@numnx
numnx deleted the fix-preview-docs-8704166769834444643 branch July 7, 2026 01:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant