Skip to content

Commit ca53d03

Browse files
committed
cleanup readme lints
1 parent 8130889 commit ca53d03

File tree

2 files changed

+29
-7
lines changed

2 files changed

+29
-7
lines changed

crates/bevy_dev_tools/src/inspector/README.md

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,38 +7,44 @@ The remote inspector has been copied from `bevy_remote_inspector` into `bevy_dev
77
## What Works
88

99
**Original standalone inspector**: The original `bevy_remote_inspector` crate works perfectly:
10+
1011
- High-performance virtual scrolling for thousands of entities
1112
- Real-time entity selection and component viewing
1213
- Static component data display
1314
- Connection status indicator
1415
- Comprehensive UI with scrollbars and responsive layout
1516

1617
**Target applications**: Demo applications work with `bevy_remote`
18+
1719
- Moving entities with changing component values
1820
- Auto-spawning entities for stress testing
1921
- Full bevy_remote integration
2022

2123
## What Needs Work
2224

2325
**bevy_dev_tools integration**: The inspector code needs adaptation for bevy_dev_tools:
26+
2427
- Import issues due to individual bevy crate dependencies vs full `bevy` crate
2528
- Missing `#[derive(Resource)]` and `#[derive(Component)]` annotations
2629
- System parameter type mismatches
2730

2831
**Live streaming updates**: Currently only shows static snapshots
32+
2933
- Need to implement real SSE client for `bevy/get+watch` endpoint
3034
- Replace current polling simulation with true streaming
3135
- Add visual change indicators in UI
3236

3337
## Quick Start (Current Working Setup)
3438

3539
### 1. Run Target Application
40+
3641
```bash
3742
# From bevy_remote_inspector directory (original working version)
3843
cargo run --example moving_target_app
3944
```
4045

41-
### 2. Run Inspector
46+
### 2. Run Inspector
47+
4248
```bash
4349
# From bevy_remote_inspector directory (original working version)
4450
cargo run --bin bevy_remote_inspector
@@ -47,18 +53,21 @@ cargo run --bin bevy_remote_inspector
4753
## Migration Plan
4854

4955
### Phase 1: Fix Compilation ✋ **Current Phase**
56+
5057
- [ ] Fix bevy crate imports for bevy_dev_tools context
5158
- [ ] Add missing derive macros (`Resource`, `Component`)
5259
- [ ] Resolve system parameter type issues
5360
- [ ] Create working plugin example
5461

5562
### Phase 2: Live Updates Implementation
63+
5664
- [ ] Replace HTTP client simulation with real SSE streaming
5765
- [ ] Implement `bevy/get+watch` endpoint client
5866
- [ ] Add visual change indicators to component viewer
5967
- [ ] Add connection management (start/stop per entity)
6068

6169
### Phase 3: Integration & Testing
70+
6271
- [ ] Create plugin API for easy integration
6372
- [ ] Add comprehensive examples
6473
- [ ] Performance testing with large entity counts
@@ -67,7 +76,8 @@ cargo run --bin bevy_remote_inspector
6776
## Technical Architecture
6877

6978
### High-Level Design
70-
```
79+
80+
```text
7181
Target App (bevy_remote) <--SSE--> Inspector Plugin <--> Bevy UI
7282
│ │ │
7383
├─ Component changes ├─ HTTP Client ├─ Entity List (Virtual Scrolling)
@@ -76,7 +86,8 @@ Target App (bevy_remote) <--SSE--> Inspector Plugin <--> Bevy UI
7686
```
7787

7888
### Files Structure
79-
```
89+
90+
```text
8091
src/inspector/
8192
├── mod.rs # Plugin exports
8293
├── inspector.rs # Main plugin implementation
@@ -100,16 +111,18 @@ src/inspector/
100111

101112
## For Contributors
102113

103-
### To work on compilation fixes:
114+
### To work on compilation fixes
115+
104116
1. Focus on `src/inspector/inspector.rs` first - main plugin file
105117
2. Update imports to use individual bevy crates available in bevy_dev_tools
106118
3. Add missing derive macros where compilation errors indicate
107119

108-
### To work on live updates:
120+
### To work on live updates
121+
109122
1. See `LIVE_UPDATES_IMPLEMENTATION_PLAN.md` for complete technical specification
110123
2. Start with `src/inspector/http_client.rs` - replace simulation with real SSE
111124
3. Test with `examples/moving_target_app.rs` for obvious component changes
112125

113126
## Current Workaround
114127

115-
For immediate use of the remote inspector, use the original `bevy_remote_inspector` crate which is fully functional. The bevy_dev_tools integration can be completed over time while the working version remains available.
128+
For immediate use of the remote inspector, use the original `bevy_remote_inspector` crate which is fully functional. The bevy_dev_tools integration can be completed over time while the working version remains available.

crates/bevy_dev_tools/src/widgets/README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,15 @@ Each widget is designed to be:
1818
Text with selection and clipboard copy functionality.
1919

2020
**Features:**
21+
2122
- Click to select text
2223
- Ctrl+C to copy to clipboard
2324
- Escape to clear selection
2425
- Visual selection feedback
2526
- Cross-platform clipboard support
2627

2728
**Usage:**
29+
2830
```rust
2931
use bevy::prelude::*;
3032
use bevy_dev_tools::widgets::{SelectableText, SelectableTextPlugin};
@@ -50,6 +52,7 @@ fn setup(mut commands: Commands) {
5052
```
5153

5254
**API:**
55+
5356
- `SelectableText::new(content)`: Create selectable text component
5457
- `select_all()`: Select all text programmatically
5558
- `clear_selection()`: Clear current selection
@@ -60,13 +63,15 @@ fn setup(mut commands: Commands) {
6063
Expandable/collapsible content sections.
6164

6265
**Features:**
66+
6367
- Clickable headers to expand/collapse
6468
- Customizable styling
6569
- Nested sections support
6670
- Smooth expand/collapse animations
6771
- Custom arrow indicators
6872

6973
**Usage:**
74+
7075
```rust
7176
use bevy::prelude::*;
7277
use bevy_dev_tools::widgets::{CollapsibleSectionPlugin, spawn_collapsible_section};
@@ -110,6 +115,7 @@ fn setup(mut commands: Commands) {
110115
```
111116

112117
**API:**
118+
113119
- `spawn_collapsible_section(commands, parent, title)`: Create basic section
114120
- `spawn_collapsible_section_with_config(commands, parent, config)`: Create with custom config
115121
- `CollapsibleSection::new(title)`: Builder pattern configuration
@@ -120,6 +126,7 @@ fn setup(mut commands: Commands) {
120126
High-performance scrolling for large lists.
121127

122128
**Features:**
129+
123130
- Virtual rendering (only visible items + buffer)
124131
- Smooth momentum scrolling
125132
- Adaptive buffering during fast scrolling
@@ -128,6 +135,7 @@ High-performance scrolling for large lists.
128135
- Frame-rate limiting for performance
129136

130137
**Usage:**
138+
131139
```rust
132140
use bevy::prelude::*;
133141
use bevy_dev_tools::widgets::{
@@ -193,6 +201,7 @@ fn setup(mut commands: Commands) {
193201
```
194202

195203
**API:**
204+
196205
- `VirtualScrollable` trait: Implement for your item type
197206
- `spawn_virtual_scroll_container()`: Create scrollable container
198207
- `VirtualScrollState<T>`: Resource managing scroll state
@@ -247,4 +256,4 @@ When modifying these widgets:
247256

248257
## License
249258

250-
These widgets are part of bevy_dev_tools and follow the same license as Bevy (MIT OR Apache-2.0).
259+
These widgets are part of bevy_dev_tools and follow the same license as Bevy (MIT OR Apache-2.0).

0 commit comments

Comments
 (0)