Skip to content

Commit f3e7f19

Browse files
committed
Fix broken cross-references in docs
Update links to match new doc structure: - index.md: Update documentation table to existing pages - installation.md: Fix next steps, add inline systemd uninstall - how-it-works.md: Fix next steps links - safety.md: Fix next steps links - faq.md: Fix install.md → installation.md, update next steps - examples/README.md: Fix see also section
1 parent 0f3a1f5 commit f3e7f19

6 files changed

Lines changed: 20 additions & 20 deletions

File tree

‎docs/examples/README.md‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,6 @@ When abuse is detected, the report includes specific trigger rules, episode deta
115115

116116
## See Also
117117

118-
- [Reporting](../reporting.md) — S3 upload and pilot workflow
119-
- [Deployment Guide](../deployment.md) — Full deployment instructions
120-
- [Configuration Reference](../configuration.md) — All CLI options
121-
- [Operations Guide](../operations.md) — Monitoring and maintenance
118+
- [Reporting](../reporting.md) — Offline reporting workflow
119+
- [S3 Upload](../s3-upload.md) — Configure snapshot uploads
120+
- [Installation](../installation.md) — System requirements and setup

‎docs/faq.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -314,7 +314,7 @@ IBSR does not enforce anything. It generates evidence about what *would* happen
314314

315315
## Next Steps
316316

317-
- [Installation](install.md) — Get started
318-
- [Deployment](deployment.md) — Production deployment with S3 upload
317+
- [Installation](installation.md) — Get started
318+
- [S3 Upload](s3-upload.md) — Configure snapshot uploads
319319
- [Safety Model](safety.md) — Understand guarantees
320-
- [Reporting](reporting.md) — S3 upload and pilot workflow
320+
- [Reporting](reporting.md) — Offline reporting workflow

‎docs/how-it-works.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -276,5 +276,5 @@ On SIGINT or SIGTERM:
276276
## Next Steps
277277

278278
- [Safety Model](safety.md) — Safety guarantees and verification
279-
- [Configuration](configuration.md) — Tuning options
280279
- [Reporting](reporting.md) — Offline analysis
280+
- [FAQ](faq.md) — Common questions

‎docs/index.md‎

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -130,15 +130,11 @@ The collector runs unattended once configured. There are no dashboards to watch
130130

131131
| Document | Description |
132132
|----------|-------------|
133-
| [Installation](install.md) | System requirements and installation methods |
134-
| [Quick Start](quickstart.md) | Get running in 5 minutes |
135-
| [Configuration](configuration.md) | CLI reference and tuning options |
136-
| [Deployment](deployment.md) | Production deployment with systemd |
133+
| [Installation](installation.md) | System requirements and installation methods |
134+
| [S3 Upload](s3-upload.md) | Upload snapshots using ibsr-export |
135+
| [Reporting](reporting.md) | Offline reporting workflow |
137136
| [How It Works](how-it-works.md) | Technical deep dive |
138137
| [Safety Model](safety.md) | Safety guarantees and risk profile |
139-
| [Reporting](reporting.md) | S3 upload and report delivery |
140-
| [Operations](operations.md) | Monitoring, troubleshooting, maintenance |
141-
| [Upgrading](upgrading.md) | Version upgrades and rollback |
142138
| [FAQ](faq.md) | Frequently asked questions |
143139

144140
## Design Principles

‎docs/installation.md‎

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -237,10 +237,15 @@ sudo rm -rf /var/lib/ibsr
237237

238238
### Remove Systemd Service (If Installed)
239239

240-
See [Deployment](deployment.md) for systemd uninstall instructions.
240+
```bash
241+
sudo systemctl stop ibsr
242+
sudo systemctl disable ibsr
243+
sudo rm /etc/systemd/system/ibsr.service
244+
sudo systemctl daemon-reload
245+
```
241246

242247
## Next Steps
243248

244-
- [Quick Start](quickstart.md) — Get running in 5 minutes
245-
- [Configuration](configuration.md) — CLI options and tuning
246-
- [Deployment](deployment.md) — Production deployment with systemd
249+
- [S3 Upload](s3-upload.md) — Configure snapshot uploads
250+
- [How It Works](how-it-works.md) — Technical architecture
251+
- [Safety Model](safety.md) — Safety guarantees

‎docs/safety.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -228,5 +228,5 @@ du -sh /var/lib/ibsr/snapshots/
228228
## Next Steps
229229

230230
- [How It Works](how-it-works.md) — Technical architecture
231-
- [Operations](operations.md) — Monitoring and troubleshooting
231+
- [Reporting](reporting.md) — Offline reporting workflow
232232
- [FAQ](faq.md) — Common questions

0 commit comments

Comments
 (0)