Skip to content

Commit 577335c

Browse files
committed
ops: add status endpoint and docs link checks
1 parent 8e90f8f commit 577335c

23 files changed

Lines changed: 354 additions & 789 deletions

.github/workflows/docs-links.yml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: Docs Link Check
2+
3+
on:
4+
pull_request:
5+
branches: [main, develop]
6+
paths:
7+
- "**/*.md"
8+
- ".github/workflows/docs-links.yml"
9+
- "scripts/check_doc_links.sh"
10+
11+
jobs:
12+
docs-links:
13+
name: Validate Markdown Links
14+
runs-on: ubuntu-latest
15+
steps:
16+
- name: Checkout code
17+
uses: actions/checkout@v4
18+
19+
- name: Check local markdown links
20+
run: bash scripts/check_doc_links.sh

GETTING_STARTED.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,7 @@ cargo run --example http_client_example
4040
That example covers query registration, start, stop, replay control, and
4141
WebSocket result consumption.
4242

43-
## Optional Local Demo UI
44-
45-
This repository keeps a small static demo at
46-
`examples/demo_dashboard.html` for manual browser testing.
43+
## Optional Frontend
4744

4845
The maintained Svelte dashboard lives in the separate
4946
`SolidLabResearch/janus-dashboard` repository.
@@ -75,7 +72,7 @@ make ci-check
7572
- `src/stream`: live stream processing
7673
- `src/storage`: segmented RDF storage
7774
- `src/bin`: executable binaries
78-
- `examples`: runnable examples and a minimal static demo
75+
- `examples`: runnable examples, including the HTTP client example
7976
- `tests`: integration coverage
8077
- `docs`: current product docs plus a small amount of retained background material
8178

Makefile

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.PHONY: help build test clean fmt lint check ci-check install run dev doc bench audit deps update watch all release
1+
.PHONY: help build test clean fmt lint check ci-check install run dev doc bench audit deps update watch all release doc-links
22

33
# Default target
44
.DEFAULT_GOAL := help
@@ -59,6 +59,10 @@ lint: ## Run clippy lints
5959
check: fmt-check lint ## Run all checks (formatting and linting)
6060
@echo "$(GREEN)All checks passed!$(NC)"
6161

62+
doc-links: ## Check local markdown links
63+
@echo "$(BLUE)Checking markdown links...$(NC)"
64+
@bash ./scripts/check_doc_links.sh
65+
6266
ci-check: ## Run full CI/CD checks locally before pushing
6367
@echo "$(BLUE)Running CI/CD checks...$(NC)"
6468
@./scripts/ci-check.sh

README.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -127,10 +127,7 @@ This example demonstrates:
127127
The maintained web dashboard lives in the separate
128128
`SolidLabResearch/janus-dashboard` repository.
129129

130-
Frontend development should happen in the dedicated dashboard repo. This
131-
repository only keeps a small static demo at
132-
[`examples/demo_dashboard.html`](./examples/demo_dashboard.html) for manual API
133-
testing.
130+
Frontend development should happen in the dedicated dashboard repo.
134131

135132
## Development
136133

@@ -154,7 +151,6 @@ The repository includes runnable examples under [`examples/`](./examples), inclu
154151

155152
- [`examples/http_client_example.rs`](./examples/http_client_example.rs)
156153
- [`examples/comparator_demo.rs`](./examples/comparator_demo.rs)
157-
- [`examples/demo_dashboard.html`](./examples/demo_dashboard.html) for a minimal local demo
158154

159155
## Documentation
160156

START_HERE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ cargo run --example http_client_example
1818

1919
- `http_server` is the main backend entry point
2020
- `stream_bus_cli` is the ingestion and replay CLI
21-
- `examples/demo_dashboard.html` is an optional minimal manual demo
21+
- `examples/http_client_example.rs` is the fastest local API exercise
2222
- the maintained Svelte dashboard lives in the separate `janus-dashboard` repository
2323

2424
## Current Docs

docs/DOCUMENTATION_INDEX.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,6 @@ This is the shortest path to understanding the current Janus implementation.
6060

6161
## Dashboard Boundary
6262

63-
- Local demo dashboard in this repository: `examples/demo_dashboard.html`
6463
- Maintained dashboard repository: `https://github.com/SolidLabResearch/janus-dashboard`
6564

6665
## Related Code

docs/HTTP_API.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -857,7 +857,7 @@ Options:
857857
## Additional Resources
858858

859859
- [JanusQL Query Language Documentation](./JANUSQL.md)
860-
- [Stream Bus CLI Documentation](./STREAM_BUS.md)
860+
- [Stream Bus CLI Documentation](./STREAM_BUS_CLI.md)
861861
- [Benchmark Results](./BENCHMARK_RESULTS.md)
862862

863863
---

docs/HTTP_API_CURRENT.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,17 @@ Service Unavailable` with:
3939
}
4040
```
4141

42+
### Ops Status
43+
44+
`GET /ops/status`
45+
46+
Returns a richer operational snapshot with:
47+
48+
- overall service status
49+
- storage background-flush health
50+
- replay metrics
51+
- query lifecycle counts
52+
4253
### Register Query
4354

4455
`POST /api/queries`

docs/LIVE_STREAMING_GUIDE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,9 +50,9 @@ docker-compose up -d mosquitto
5050
./scripts/start_http_server.sh --clean
5151
```
5252

53-
### 3. Open Demo Client
53+
### 3. Start a Client
5454

55-
Open `examples/demo_dashboard.html` in your browser.
55+
Use the maintained dashboard repository or run the local HTTP client example.
5656

5757
### 4. Start Replay (Publishes to MQTT + Storage)
5858

docs/QUICKSTART_HTTP_API.md

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ cargo run --bin http_server
1212

1313
```bash
1414
curl http://localhost:8080/health
15+
curl http://localhost:8080/ops/status
1516
```
1617

1718
## 3. Register a query
@@ -65,14 +66,7 @@ Check replay metrics:
6566
curl http://localhost:8080/api/replay/status
6667
```
6768

68-
## Optional Demo Client
69-
70-
This repository still contains a static demo HTML client for manual API
71-
testing:
72-
73-
```bash
74-
open examples/demo_dashboard.html
75-
```
69+
## Optional Frontend
7670

7771
For the maintained frontend, use:
7872

0 commit comments

Comments
 (0)