Skip to content

Commit fa8d673

Browse files
committed
Fix double dot-slash in docs and update script references
1 parent 6feccca commit fa8d673

22 files changed

Lines changed: 74 additions & 55 deletions

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ check: fmt-check lint ## Run all checks (formatting and linting)
6161

6262
ci-check: ## Run full CI/CD checks locally before pushing
6363
@echo "$(BLUE)Running CI/CD checks...$(NC)"
64-
@./ci-check.sh
64+
@./scripts/ci-check.sh
6565

6666
clean: ## Clean build artifacts
6767
@echo "$(BLUE)Cleaning build artifacts...$(NC)"

README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,7 @@ Before pushing to the repository, run the CI/CD checks locally:
5151
make ci-check
5252

5353
# Or use the script directly
54-
./ci-check.sh
55-
```
54+
./scripts/ci-check.sh```
5655
5756
This will run:
5857
- **rustfmt** - Code formatting check

START_HERE.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,7 @@
44

55
```bash
66
# 1. Setup (one time)
7-
./test_setup.sh
8-
7+
./scripts/test_setup.sh
98
# 2. Start MQTT
109
docker-compose up -d mosquitto
1110

docs/DOCUMENTATION_INDEX.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Getting Started
44

55
1. **START_HERE.md** - 🚀 BEGIN HERE - Quick start guide
6-
2. **test_setup.sh** - Automated setup script
6+
2. **scripts/test_setup.sh** - Automated setup script
77
3. **docker-compose.yml** - MQTT broker configuration
88

99
## Quick Reference

docs/LIVE_STREAMING_GUIDE.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ docker-compose up -d mosquitto
4747
### 2. Start HTTP Server
4848

4949
```bash
50-
./start_http_server.sh --clean
50+
./scripts/start_http_server.sh --clean
5151
```
5252

5353
### 3. Open Dashboard
@@ -201,7 +201,7 @@ Results stream via WebSocket as JSON:
201201
```bash
202202
# Clean storage and restart
203203
rm -rf data/storage/*
204-
./start_http_server.sh
204+
./scripts/start_http_server.sh
205205
```
206206

207207
### No Live Results
@@ -266,7 +266,7 @@ docker-compose restart mosquitto
266266
Use the automated test script:
267267

268268
```bash
269-
./test_live_streaming.sh
269+
./scripts/test_live_streaming.sh
270270
```
271271

272272
This script:

docs/LIVE_STREAMING_READY.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ WebSocket → Dashboard
4545

4646
```bash
4747
cd /Users/kushbisen/Code/janus
48-
./test_live_streaming.sh
48+
./scripts/test_live_streaming.sh
4949
```
5050

5151
This runs a complete test cycle and shows you if everything works.
@@ -56,7 +56,7 @@ This runs a complete test cycle and shows you if everything works.
5656

5757
```bash
5858
cd /Users/kushbisen/Code/janus
59-
./start_http_server.sh --clean
59+
./scripts/start_http_server.sh --clean
6060
```
6161

6262
You should see:
@@ -184,7 +184,7 @@ The live results will keep coming because `loop_file: true` continuously replays
184184
# Clean storage
185185
rm -rf data/storage/*
186186
# Restart server
187-
./start_http_server.sh
187+
./scripts/start_http_server.sh
188188
```
189189

190190
#### Issue: Only historical results, no live results

docs/QUICK_REFERENCE.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Setup (3 Commands)
44

55
```bash
6-
./test_setup.sh # One-time setup
6+
./scripts/test_setup.sh # One-time setup
77
docker-compose up -d mosquitto # Start MQTT
88
cargo run --bin http_server # Start server
99
```
@@ -104,7 +104,7 @@ janus/
104104
├── COMPLETE_SOLUTION.md # Full explanation
105105
├── SETUP_GUIDE.md # Detailed setup
106106
├── README_HTTP_API.md # API guide
107-
└── test_setup.sh # Automated setup
107+
└── ./scripts/test_setup.sh # Automated setup
108108
```
109109

110110
## Success Checklist
@@ -119,4 +119,4 @@ janus/
119119

120120
---
121121

122-
**Quick Start:** `./test_setup.sh` then `cargo run --bin http_server`
122+
**Quick Start:** `./scripts/test_setup.sh` then `cargo run --bin http_server`

docs/README_HTTP_API.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ git clone https://github.com/SolidLabResearch/janus.git
4444
cd janus
4545

4646
# Run automated setup
47-
./test_setup.sh
47+
./scripts/test_setup.sh
4848

4949
# Start HTTP server (in new terminal)
5050
cargo run --bin http_server

docs/RSP_INTEGRATION_COMPLETE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ Total results received: 21
136136

137137
### CI/CD Checks
138138
```bash
139-
./ci-check.sh
139+
./scripts/ci-check.sh
140140
✅ Formatting check passed!
141141
✅ Clippy check passed!
142142
✅ All tests passed!
@@ -323,7 +323,7 @@ cargo run --example live_stream_processing_example
323323

324324
**CI/CD Check:**
325325
```bash
326-
./ci-check.sh
326+
./scripts/ci-check.sh
327327
```
328328

329329
**Format Code:**

examples/test_query_pipeline.rs

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
use janus::{
2-
api::janus_api::JanusApi,
3-
parsing::janusql_parser::JanusQLParser,
4-
registry::query_registry::QueryRegistry,
5-
storage::segmented_storage::StreamingSegmentedStorage,
2+
api::janus_api::JanusApi, parsing::janusql_parser::JanusQLParser,
3+
registry::query_registry::QueryRegistry, storage::segmented_storage::StreamingSegmentedStorage,
64
storage::util::StreamingConfig,
75
};
86
use std::sync::Arc;
@@ -22,7 +20,8 @@ WHERE {
2220
?sensor ex:temperature ?temp .
2321
}
2422
}
25-
"#.trim();
23+
"#
24+
.trim();
2625

2726
println!("Testing query pipeline...\n");
2827
println!("Query:\n{}\n", janusql);
@@ -37,15 +36,15 @@ WHERE {
3736
};
3837

3938
let storage = Arc::new(StreamingSegmentedStorage::new(config).expect("Failed to load storage"));
40-
39+
4140
let events = storage.query(0, u64::MAX).expect("Storage query failed");
4241
println!("Storage has {} events", events.len());
43-
42+
4443
if events.len() > 0 {
4544
let dict = storage.get_dictionary().read().unwrap();
4645
println!("\nFirst 3 events decoded:");
4746
for (i, e) in events.iter().take(3).enumerate() {
48-
println!("Event {}:", i+1);
47+
println!("Event {}:", i + 1);
4948
println!(" subject: {:?}", dict.decode(e.subject));
5049
println!(" predicate: {:?}", dict.decode(e.predicate));
5150
println!(" object: {:?}", dict.decode(e.object));
@@ -83,7 +82,7 @@ WHERE {
8382
println!("\nWaiting for results (5 seconds)...");
8483
let start = std::time::Instant::now();
8584
let mut result_count = 0;
86-
85+
8786
while start.elapsed().as_secs() < 5 {
8887
if let Some(result) = handle.try_receive() {
8988
result_count += 1;
@@ -92,7 +91,7 @@ WHERE {
9291
println!(" Timestamp: {}", result.timestamp);
9392
println!(" Bindings ({} items):", result.bindings.len());
9493
for (i, binding) in result.bindings.iter().take(3).enumerate() {
95-
println!(" {}: {:?}", i+1, binding);
94+
println!(" {}: {:?}", i + 1, binding);
9695
}
9796
} else {
9897
std::thread::sleep(std::time::Duration::from_millis(100));

0 commit comments

Comments
 (0)