Skip to content

Commit 19ed80c

Browse files
committed
UPDATE looking glass docs to mention deeplinks
Signed-off-by: ParleSec <mason@masonparle.com>
1 parent 479a3a1 commit 19ed80c

1 file changed

Lines changed: 19 additions & 0 deletions

File tree

docs/starlight/src/content/docs/using/looking-glass.mdx

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,25 @@ Each flow execution produces a timeline of events:
3131

3232
Every event includes an annotation with RFC references (for example "RFC 6749 Section 4.1") and security context explaining what the step does and why.
3333

34+
## Deep-Links and URL State
35+
36+
Looking Glass supports shareable deep-links in the format `/looking-glass?protocol=X&flow=Y`. These links are generated by the palette search (cmd+K) and the **Share** button in the flow toolbar.
37+
38+
URL query parameters follow a consume-and-clear lifecycle:
39+
40+
- When a deep-link is opened, the `?protocol=` and `?flow=` params are read and applied, then removed from the address bar.
41+
- Changing protocol or flow via the UI dropdowns updates the URL to reflect the new selection.
42+
- Resetting or clearing the flow strips query params entirely.
43+
- Navigating away from Looking Glass always results in a clean URL on return.
44+
45+
When a flow is selected, three icon buttons appear next to the protocol/flow dropdowns:
46+
47+
| Control | What It Does |
48+
|---------|-------------|
49+
| **Reset** | Resets the current flow execution to its initial state and clears the URL |
50+
| **Share** | Copies a shareable deep-link for the current protocol and flow to the clipboard |
51+
| **Clear** | Clears all selections (protocol, flow, tokens, configuration), resets every input field, and strips query params from the URL |
52+
3453
## Session Management
3554

3655
Each flow execution creates a Looking Glass session. Sessions are linked to backend processing via:

0 commit comments

Comments
 (0)