zwave-js / zwave-js-ui / 22300148887

19%

push

github

docs: fix outdated content, dead links, and add missing settings (#4556)

## Summary

- **Rewrite `docs/guide/plugins.md`**: Fix API description from
`require()` to ES `import()` + class constructor, document
`CustomPlugin` interface, fix Docker path from `/usr/app/` to
`/usr/src/app`, add volume mount approach, remove outdated/renamed
plugin references
- **Fix dead link in `docs/getting-started/quick-start.md`**: Replace
nonexistent `troubleshooting/troubleshooting.md` with links to actual
troubleshooting pages
- **Fix and expand `docs/guide/faq.md`**: Fix `/hass/devices.js`
reference to `api/hass/devices.ts`, add 4 common FAQ entries (updating,
backups, security keys, Docker plugins)
- **Add env vars to `docs/guide/env-vars.md`**: Document `ZWAVE_PORT`
and `ZWAVE_EXTERNAL_SETTINGS`
- **Update `docs/troubleshooting/app_crash.md`**: Recommend Bookworm as
current Raspberry Pi OS release
- **Add missing settings to `docs/usage/setup.md`**:
- New **UI** section (color scheme, tab navigation, streamer mode,
compact view, browser title)
- Z-Wave: Long Range security keys, RF configuration subsection,
recovery/watchdog settings, timeouts, firmware update checks, optimistic
value updates
- New **Zniffer** section (enabled, port, security keys, RSSI, logging)

## Test plan

- [x] `npm run lint` passes clean (ESLint + markdownlint)
- [ ] Verify all internal doc links point to existing files
- [ ] Verify plugin interface matches `api/lib/CustomPlugin.ts`
- [ ] Verify Docker path matches `docker/Dockerfile` WORKDIR
- [ ] Visual review of rendered markdown

🤖 Generated with [Claude Code](https://claude.com/claude-code)

---------

Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>

334 of 444 branches covered (75.23%)

Branch coverage included in aggregate %.

4052 of 22347 relevant lines covered (18.13%)

1.13 hits per line