Skip to content

Commit 5cdd2d4

Browse files
kraleppahhubert6
andcommitted
Docs: adjust docs for LiveDebugger website (#829)
Co-authored-by: Hubert Kasprzycki <[email protected]>
1 parent a9c3c6e commit 5cdd2d4

File tree

5 files changed

+108
-16
lines changed

5 files changed

+108
-16
lines changed

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,12 @@ LiveDebugger is a browser-based tool for debugging applications written in [Phoe
1212

1313
Designed to enhance your development experience LiveDebugger gives you:
1414

15-
- :deciduous_tree: A detailed view of your LiveComponents tree
16-
- :mag: The ability to inspect assigns for LiveViews and LiveComponents
17-
- :link: Tracing and filtering of their callback executions
18-
- :flashlight: Components highlighting
15+
- 🌳 See your LiveComponents tree
16+
- 🔍 View assigns
17+
- 🔗 Trace and filter callback executions
18+
- 🔦 Inspect elements
19+
20+
Check out our comprehensive [Features Overview](https://hexdocs.pm/live_debugger/features.html) to explore all capabilities in detail.
1921

2022
https://github.com/user-attachments/assets/a09d440c-4217-4597-b30e-f8b911a9094a
2123

docs/elements_inspection.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ You can enable inspecting mode in two ways:
3030
3131
- Using `Debug Button` in the debugged LiveView window (clicking button and selecting from menu)
3232
33-
- Using `Inspect Element` button in the LiveDebugger (not available in `Dead View Mode`)
33+
- Using `Inspect Element` button in the LiveDebugger (not available in `DeadView Mode`)
3434
3535
![Inspect Element Button](images/inspect_element_button.png)
3636

docs/features.md

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
# Features Overview
2+
3+
LiveDebugger provides a comprehensive set of tools designed to improve Phoenix LiveView debugging and development. From real-time state inspection to performance profiling, these features give you deep visibility into your application's behavior.
4+
5+
## Features
6+
7+
### [Assigns Inspection](assigns_inspection.md)
8+
9+
Inspect the current state of assigns for any LiveView or LiveComponent in your application. Updated in real-time, this feature acts like a live `IO.inspect/1` with context, helping you track state changes, debug reactivity issues, and spot bugs faster.
10+
11+
**Key capabilities:**
12+
13+
- Real-time assign updates
14+
- Copy assigns for IEx processing
15+
- Expandable/collapsible complex data structures
16+
- Immediate feedback on user interactions
17+
18+
### [Callback Tracing](callback_tracing.md)
19+
20+
See how functions in your LiveView application are being called with comprehensive tracing capabilities. Monitor all LiveView and LiveComponent callbacks with detailed execution information including timing, arguments, and execution flow.
21+
22+
**Key capabilities:**
23+
24+
- Filter by callback type, execution time, or search terms
25+
- Detailed argument inspection with fullscreen view
26+
- Copy callback arguments for terminal processing
27+
- Support for all Phoenix.LiveView and Phoenix.LiveComponent callbacks
28+
29+
### [Components Highlighting](components_highlighting.md)
30+
31+
Visually identify and locate components rendered in your current debugged LiveView. Hover over component names in the tree to highlight their corresponding DOM elements in your application.
32+
33+
**Key capabilities:**
34+
35+
- Toggle highlighting mode on/off
36+
- Hover-to-highlight functionality
37+
- Non-intrusive visual feedback
38+
39+
### [Components Tree](components_tree.md)
40+
41+
Examine how LiveComponents are arranged in your debugged LiveView. The tree automatically updates when state changes, showing the complete hierarchy from LiveView root to all nested LiveComponents with their CIDs.
42+
43+
**Key capabilities:**
44+
45+
- Discover your application's structure
46+
- Real-time tree updates on state changes
47+
- View nested LiveView relationships
48+
49+
### [DeadView Mode](dead_view_mode.md)
50+
51+
Debug the state of your application after redirecting or encountering a crash. This feature preserves the last known state and callback history, allowing you to investigate what went wrong even after the process has terminated.
52+
53+
**Key capabilities:**
54+
55+
- Inspect last state of LiveView or LiveComponents
56+
- Review callback execution order
57+
- See which callback crashed the process
58+
- Continue to successor LiveView after debugging
59+
- Status indicator showing alive/dead state
60+
61+
### [Elements Inspection](elements_inspection.md)
62+
63+
Inspect LiveViews and LiveComponents directly from the rendered page by selecting elements with your mouse.
64+
65+
**Key capabilities:**
66+
67+
- Two activation methods: Debug Button or Inspect Element button
68+
- Hover preview with element information
69+
- Click to inspect node
70+
- Highlight elements during selection
71+
- Works in both standalone and DevTools extension modes
72+
73+
## Browser Features
74+
75+
Some features require JavaScript injection into your debugged application for enhanced functionality:
76+
77+
- **Components Highlighting** - Visual DOM highlighting
78+
- **Elements Inspection** - Mouse-based element selection
79+
80+
These features are enabled by default but can be configured. See the [Configuration](config.md) page for details.

docs/welcome.md

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,24 @@ LiveDebugger is a browser-based tool for debugging applications written in [Phoe
44

55
Designed to enhance your development experience LiveDebugger gives you:
66

7-
- A detailed view of your LiveComponents tree ([`Components Tree`](./components_tree.md))
8-
- The ability to inspect assigns for LiveViews and LiveComponents ([`Assigns Inspection`](./assigns_inspection.md))
9-
- Tracing of their callback executions ([`Callback Tracing`](./callback_tracing.md))
10-
- Highlighting components in debugged app ([`Components Highlighting`](./components_highlighting.md))
11-
- Inspecting elements on the page ([`Elements Inspection`](./elements_inspection.md))
12-
13-
> ### Call to action {: .info}
7+
- See your LiveComponents tree
8+
- View assigns
9+
- Trace and filter callback executions
10+
- Inspect elements
11+
12+
Check out our comprehensive [Features Overview](./features.md) to explore all capabilities in detail.
13+
14+
<div style="position: relative; padding-bottom: 56.25%; height: 0; overflow: hidden; max-width: 100%;">
15+
<iframe
16+
src="https://www.youtube.com/embed/yv39lCkoZKM?si=aqj5tu-J2ueCqEL2"
17+
style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"
18+
frameborder="0"
19+
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
20+
allowfullscreen>
21+
</iframe>
22+
</div>
23+
24+
> #### Call to action {: .info}
1425
>
1526
> We are currently taking a survey to improve LiveDebugger and decide its future.
1627
>

mix.exs

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -99,19 +99,18 @@ defmodule LiveDebugger.MixProject do
9999
extras: [
100100
"CHANGELOG.md",
101101
"docs/welcome.md": [title: "Welcome to LiveDebugger"],
102+
"docs/features.md": [title: "Features Overview"],
102103
"docs/config.md": [title: "Configuration"],
103104
"docs/components_tree.md": [title: "Components Tree"],
104105
"docs/assigns_inspection.md": [title: "Assigns Inspection"],
105106
"docs/callback_tracing.md": [title: "Callback Tracing"],
106107
"docs/components_highlighting.md": [title: "Components Highlighting"],
107-
"docs/dead_view_mode.md": [title: "Dead View Mode"],
108+
"docs/dead_view_mode.md": [title: "DeadView Mode"],
108109
"docs/elements_inspection.md": [title: "Elements Inspection"]
109110
],
110111
groups_for_extras: [
111-
Configuration: [
112-
"docs/config.md"
113-
],
114112
Features: [
113+
"docs/features.md",
115114
"docs/assigns_inspection.md",
116115
"docs/components_tree.md",
117116
"docs/callback_tracing.md",

0 commit comments

Comments
 (0)