Skip to content

docs: surface mirrord up, local UI, and browser extension in onboarding - #303

Open
trawler wants to merge 1 commit into
mainfrom
karena/cor-1645-quick-start-up-ui-browser
Open

docs: surface mirrord up, local UI, and browser extension in onboarding#303
trawler wants to merge 1 commit into
mainfrom
karena/cor-1645-quick-start-up-ui-browser

Conversation

@trawler

@trawler trawler commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

What

Makes mirrord up, mirrord ui, and the browser extension discoverable from the getting started content.

  • Quick Start: new "Multiple services" subsection under Try it (mirrord up init + mirrord up), new "Watch your sessions" (mirrord ui) and "Test from your browser" (extension) sections, plus two new Next Steps rows.
  • Cross-links to the mirrord up page from Welcome, What is mirrord, Remocal Development, and Incoming Traffic.
  • Nav: mirrord up entry moves from Using mirrord to Use Cases (right after Remocal Development) and is renamed to "mirrord up (Multiple Services)". File path unchanged, URL stays the same.

Why

Consistent feedback that getting started is daunting and these features are invisible in onboarding. mirrord up in particular was only reachable via the sidebar deep in Using mirrord and the feature matrix.

Closes COR-1645

@linear-code

linear-code Bot commented Aug 5, 2026

Copy link
Copy Markdown

COR-1645

@greptile-apps

greptile-apps Bot commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

The PR makes multi-service workflows, session monitoring, and browser-based testing more visible during onboarding.

  • Adds mirrord up, Local UI, and browser-extension guidance to the Quick Start.
  • Cross-links the multi-session workflow from introductory and traffic documentation.
  • Moves the existing mirrord up page into the Use Cases navigation section without changing its URL.

Important Files Changed

Filename Overview
docs/getting-started/quick-start.md Adds onboarding instructions for multiple services, session monitoring, and browser routing, including the session and HTTP-filter prerequisites requested in the previous review.
docs/SUMMARY.md Moves and renames the existing mirrord up navigation entry while retaining its current destination.
docs/README.md Introduces mirrord up as the multi-service workflow from the documentation landing page.
docs/getting-started/what-is-mirrord.md Adds a concise cross-link to the multi-session workflow.
docs/use-cases/local-development.md Expands the multiple-sessions benefit to mention mirrord up lifecycle management.
docs/using-mirrord/incoming-traffic/README.md Links filtered multi-service traffic stealing to the mirrord up guide.

Reviews (2): Last reviewed commit: "docs: surface mirrord up, local UI, and ..." | Re-trigger Greptile

@trawler
trawler force-pushed the karena/cor-1645-quick-start-up-ui-browser branch 3 times, most recently from c00f428 to 434bacf Compare August 5, 2026 15:34
Quick start covers mirrord up under Try it, adds Watch your sessions
(mirrord ui) and Test from your browser (extension) sections, and
links all three from the Next Steps table.

Welcome, What is mirrord, Remocal Development, and Incoming Traffic
now cross-link the mirrord up page. Nav entry moves from Using
mirrord to Use Cases, right after Remocal Development, renamed to
"mirrord up (Multiple Concurrent Sessions)".

COR-1645
@trawler
trawler force-pushed the karena/cor-1645-quick-start-up-ui-browser branch from 434bacf to fd16889 Compare August 5, 2026 15:36
@trawler

trawler commented Aug 5, 2026

Copy link
Copy Markdown
Contributor Author

@greptileai recheck

@trawler
trawler requested a review from liron-sel August 5, 2026 15:43
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