Skip to content

Commit 4d06f17

Browse files
itsDNNSclaude
andcommitted
Add table of contents and collapsible sections to README.md
- Add ToC with anchor links - Wrap Configuration, Screenshots, Created Sensors, and Reference Values in collapsible <details> blocks to reduce scroll length - Keep Features, Quick Start, Requirements, Roadmap, and Contributing always visible as primary content Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent d4c180a commit 4d06f17

File tree

1 file changed

+28
-4
lines changed

1 file changed

+28
-4
lines changed

README.md

Lines changed: 28 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,18 @@
1010

1111
![Dashboard Dark Mode](docs/screenshots/dashboard-dark.png)
1212

13+
## Table of Contents
14+
15+
- [Features](#features)
16+
- [Quick Start](#quick-start)
17+
- [Configuration](#configuration)
18+
- [Screenshots](#screenshots)
19+
- [Created Sensors](#created-sensors)
20+
- [Reference Values](#reference-values)
21+
- [Requirements](#requirements)
22+
- [Roadmap](#roadmap)
23+
- [Contributing](#contributing)
24+
1325
## Features
1426

1527
- **Web Dashboard**: Real-time channel data with health assessment, trend charts, and calendar navigation
@@ -42,7 +54,8 @@ cd docsight
4254
docker compose up -d
4355
```
4456

45-
## Configuration
57+
<details>
58+
<summary><h2>Configuration</h2></summary>
4659

4760
Configuration is stored in `config.json` inside the Docker volume and persists across restarts. Environment variables override config.json values.
4861

@@ -75,7 +88,10 @@ Copy `.env.example` to `.env` and edit:
7588
| `HISTORY_DAYS` | `7` | Snapshot retention in days |
7689
| `ADMIN_PASSWORD` | - | Web UI password (optional) |
7790

78-
## Screenshots
91+
</details>
92+
93+
<details>
94+
<summary><h2>Screenshots</h2></summary>
7995

8096
| Dashboard (Dark) | Dashboard (Light) | Setup Wizard |
8197
|---|---|---|
@@ -85,7 +101,10 @@ Copy `.env.example` to `.env` and edit:
85101
|---|---|
86102
| ![Trends](docs/screenshots/trends.png) | ![Health](docs/screenshots/health-banner.png) |
87103

88-
## Created Sensors
104+
</details>
105+
106+
<details>
107+
<summary><h2>Created Sensors</h2></summary>
89108

90109
### Per-Channel (~37 DS + 4 US)
91110

@@ -106,14 +125,19 @@ Copy `.env.example` to `.env` and edit:
106125
| `docsight_us_total` | - | Number of upstream channels |
107126
| `docsight_us_power_min/max/avg` | dBmV | Upstream power range |
108127

109-
## Reference Values
128+
</details>
129+
130+
<details>
131+
<summary><h2>Reference Values</h2></summary>
110132

111133
| Metric | Good | Marginal | Poor |
112134
|---|---|---|---|
113135
| DS Power | -7..+7 dBmV | +/-7..+/-10 | > +/-10 dBmV |
114136
| US Power | 35..49 dBmV | 50..54 | > 54 dBmV |
115137
| SNR / MER | > 30 dB | 25..30 | < 25 dB |
116138

139+
</details>
140+
117141
## Requirements
118142

119143
- AVM FRITZ!Box Cable router (tested with 6690 Cable)

0 commit comments

Comments
 (0)